

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>cephadm &mdash; Ceph Documentation</title>
  

  
  <link rel="stylesheet" href="../../_static/ceph.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" />

  
  
    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
  

  
  

  

  
  <!--[if lt IE 9]>
    <script src="../../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
        <script src="../../_static/jquery.js"></script>
        <script src="../../_static/underscore.js"></script>
        <script src="../../_static/doctools.js"></script>
    
    <script type="text/javascript" src="../../_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="../../genindex/" />
    <link rel="search" title="Search" href="../../search/" />
    <link rel="next" title="体系结构" href="../../architecture/" />
    <link rel="prev" title="API 文档" href="../" /> 
</head>

<body class="wy-body-for-nav">

   
  <header class="top-bar">
    

















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../../" class="icon icon-home"></a> &raquo;</li>
        
          <li><a href="../">API 文档</a> &raquo;</li>
        
      <li>cephadm</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../../_sources/api/mon_command_api.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
  </header>
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search"  style="background: #eee" >
          

          
            <a href="../../">
          

          
            
            <img src="../../_static/logo.png" class="logo" alt="Logo"/>
          
          </a>

          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search/" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../start/intro/">Ceph 简介</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../install/">安装 Ceph</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cephadm/">Cephadm</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../rados/">Ceph 存储集群</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cephfs/">Ceph 文件系统</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../rbd/">Ceph 块设备</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../radosgw/">Ceph 对象网关</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../mgr/">Ceph 管理器守护进程</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../mgr/dashboard/">Ceph 仪表盘</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../">API 文档</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../#ceph-restful-api">Ceph RESTful API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../#ceph-api">Ceph 存储集群 API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../#id1">Ceph 文件系统 API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../#id2">Ceph 块设备 API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../#ceph-rados-apis">Ceph RADOS 网关 APIs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../#id3">Ceph 对象存储 API</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../#ceph-mon-api">Ceph MON 命令 API</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">cephadm</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-check-host">cephadm check-host</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-clear-key">cephadm clear-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-clear-ssh-config">cephadm clear-ssh-config</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-config-check-disable">cephadm config-check disable</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-config-check-enable">cephadm config-check enable</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-config-check-ls">cephadm config-check ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-config-check-status">cephadm config-check status</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-generate-key">cephadm generate-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-get-extra-ceph-conf">cephadm get-extra-ceph-conf</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-get-pub-key">cephadm get-pub-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-get-ssh-config">cephadm get-ssh-config</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-get-user">cephadm get-user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-osd-activate">cephadm osd activate</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-prepare-host">cephadm prepare-host</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-registry-login">cephadm registry-login</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-set-extra-ceph-conf">cephadm set-extra-ceph-conf</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-set-priv-key">cephadm set-priv-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-set-pub-key">cephadm set-pub-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-set-ssh-config">cephadm set-ssh-config</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cephadm-set-user">cephadm set-user</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#dashboard">dashboard</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-create-self-signed-cert">dashboard create-self-signed-cert</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-account-lockout-attempts">dashboard get-account-lockout-attempts</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-alertmanager-api-host">dashboard get-alertmanager-api-host</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-alertmanager-api-ssl-verify">dashboard get-alertmanager-api-ssl-verify</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-audit-api-enabled">dashboard get-audit-api-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-audit-api-log-payload">dashboard get-audit-api-log-payload</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-enable-browsable-api">dashboard get-enable-browsable-api</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-ganesha-clusters-rados-pool-namespace">dashboard get-ganesha-clusters-rados-pool-namespace</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-grafana-api-password">dashboard get-grafana-api-password</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-grafana-api-ssl-verify">dashboard get-grafana-api-ssl-verify</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-grafana-api-url">dashboard get-grafana-api-url</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-grafana-api-username">dashboard get-grafana-api-username</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-grafana-frontend-api-url">dashboard get-grafana-frontend-api-url</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-grafana-update-dashboards">dashboard get-grafana-update-dashboards</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-iscsi-api-ssl-verification">dashboard get-iscsi-api-ssl-verification</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-issue-tracker-api-key">dashboard get-issue-tracker-api-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-jwt-token-ttl">dashboard get-jwt-token-ttl</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-prometheus-api-host">dashboard get-prometheus-api-host</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-prometheus-api-ssl-verify">dashboard get-prometheus-api-ssl-verify</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-pwd-policy-check-complexity-enabled">dashboard get-pwd-policy-check-complexity-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-pwd-policy-check-exclusion-list-enabled">dashboard get-pwd-policy-check-exclusion-list-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-pwd-policy-check-length-enabled">dashboard get-pwd-policy-check-length-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-pwd-policy-check-oldpwd-enabled">dashboard get-pwd-policy-check-oldpwd-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-pwd-policy-check-repetitive-chars-enabled">dashboard get-pwd-policy-check-repetitive-chars-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-pwd-policy-check-sequential-chars-enabled">dashboard get-pwd-policy-check-sequential-chars-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-pwd-policy-check-username-enabled">dashboard get-pwd-policy-check-username-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-pwd-policy-enabled">dashboard get-pwd-policy-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-pwd-policy-exclusion-list">dashboard get-pwd-policy-exclusion-list</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-pwd-policy-min-complexity">dashboard get-pwd-policy-min-complexity</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-pwd-policy-min-length">dashboard get-pwd-policy-min-length</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-rest-requests-timeout">dashboard get-rest-requests-timeout</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-rgw-api-access-key">dashboard get-rgw-api-access-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-rgw-api-admin-resource">dashboard get-rgw-api-admin-resource</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-rgw-api-secret-key">dashboard get-rgw-api-secret-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-rgw-api-ssl-verify">dashboard get-rgw-api-ssl-verify</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-user-pwd-expiration-span">dashboard get-user-pwd-expiration-span</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-user-pwd-expiration-warning-1">dashboard get-user-pwd-expiration-warning-1</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-get-user-pwd-expiration-warning-2">dashboard get-user-pwd-expiration-warning-2</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-grafana-dashboards-update">dashboard grafana dashboards update</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-account-lockout-attempts">dashboard reset-account-lockout-attempts</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-alertmanager-api-host">dashboard reset-alertmanager-api-host</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-alertmanager-api-ssl-verify">dashboard reset-alertmanager-api-ssl-verify</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-audit-api-enabled">dashboard reset-audit-api-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-audit-api-log-payload">dashboard reset-audit-api-log-payload</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-enable-browsable-api">dashboard reset-enable-browsable-api</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-ganesha-clusters-rados-pool-namespace">dashboard reset-ganesha-clusters-rados-pool-namespace</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-grafana-api-password">dashboard reset-grafana-api-password</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-grafana-api-ssl-verify">dashboard reset-grafana-api-ssl-verify</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-grafana-api-url">dashboard reset-grafana-api-url</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-grafana-api-username">dashboard reset-grafana-api-username</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-grafana-frontend-api-url">dashboard reset-grafana-frontend-api-url</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-grafana-update-dashboards">dashboard reset-grafana-update-dashboards</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-iscsi-api-ssl-verification">dashboard reset-iscsi-api-ssl-verification</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-issue-tracker-api-key">dashboard reset-issue-tracker-api-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-prometheus-api-host">dashboard reset-prometheus-api-host</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-prometheus-api-ssl-verify">dashboard reset-prometheus-api-ssl-verify</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-pwd-policy-check-complexity-enabled">dashboard reset-pwd-policy-check-complexity-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-pwd-policy-check-exclusion-list-enabled">dashboard reset-pwd-policy-check-exclusion-list-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-pwd-policy-check-length-enabled">dashboard reset-pwd-policy-check-length-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-pwd-policy-check-oldpwd-enabled">dashboard reset-pwd-policy-check-oldpwd-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-pwd-policy-check-repetitive-chars-enabled">dashboard reset-pwd-policy-check-repetitive-chars-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-pwd-policy-check-sequential-chars-enabled">dashboard reset-pwd-policy-check-sequential-chars-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-pwd-policy-check-username-enabled">dashboard reset-pwd-policy-check-username-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-pwd-policy-enabled">dashboard reset-pwd-policy-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-pwd-policy-exclusion-list">dashboard reset-pwd-policy-exclusion-list</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-pwd-policy-min-complexity">dashboard reset-pwd-policy-min-complexity</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-pwd-policy-min-length">dashboard reset-pwd-policy-min-length</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-rest-requests-timeout">dashboard reset-rest-requests-timeout</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-rgw-api-access-key">dashboard reset-rgw-api-access-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-rgw-api-admin-resource">dashboard reset-rgw-api-admin-resource</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-rgw-api-secret-key">dashboard reset-rgw-api-secret-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-rgw-api-ssl-verify">dashboard reset-rgw-api-ssl-verify</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-user-pwd-expiration-span">dashboard reset-user-pwd-expiration-span</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-user-pwd-expiration-warning-1">dashboard reset-user-pwd-expiration-warning-1</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-reset-user-pwd-expiration-warning-2">dashboard reset-user-pwd-expiration-warning-2</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-account-lockout-attempts">dashboard set-account-lockout-attempts</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-alertmanager-api-host">dashboard set-alertmanager-api-host</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-alertmanager-api-ssl-verify">dashboard set-alertmanager-api-ssl-verify</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-audit-api-enabled">dashboard set-audit-api-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-audit-api-log-payload">dashboard set-audit-api-log-payload</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-enable-browsable-api">dashboard set-enable-browsable-api</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-ganesha-clusters-rados-pool-namespace">dashboard set-ganesha-clusters-rados-pool-namespace</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-grafana-api-password">dashboard set-grafana-api-password</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-grafana-api-ssl-verify">dashboard set-grafana-api-ssl-verify</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-grafana-api-url">dashboard set-grafana-api-url</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-grafana-api-username">dashboard set-grafana-api-username</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-grafana-frontend-api-url">dashboard set-grafana-frontend-api-url</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-grafana-update-dashboards">dashboard set-grafana-update-dashboards</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-iscsi-api-ssl-verification">dashboard set-iscsi-api-ssl-verification</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-issue-tracker-api-key">dashboard set-issue-tracker-api-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-jwt-token-ttl">dashboard set-jwt-token-ttl</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-prometheus-api-host">dashboard set-prometheus-api-host</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-prometheus-api-ssl-verify">dashboard set-prometheus-api-ssl-verify</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-pwd-policy-check-complexity-enabled">dashboard set-pwd-policy-check-complexity-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-pwd-policy-check-exclusion-list-enabled">dashboard set-pwd-policy-check-exclusion-list-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-pwd-policy-check-length-enabled">dashboard set-pwd-policy-check-length-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-pwd-policy-check-oldpwd-enabled">dashboard set-pwd-policy-check-oldpwd-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-pwd-policy-check-repetitive-chars-enabled">dashboard set-pwd-policy-check-repetitive-chars-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-pwd-policy-check-sequential-chars-enabled">dashboard set-pwd-policy-check-sequential-chars-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-pwd-policy-check-username-enabled">dashboard set-pwd-policy-check-username-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-pwd-policy-enabled">dashboard set-pwd-policy-enabled</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-pwd-policy-exclusion-list">dashboard set-pwd-policy-exclusion-list</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-pwd-policy-min-complexity">dashboard set-pwd-policy-min-complexity</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-pwd-policy-min-length">dashboard set-pwd-policy-min-length</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-rest-requests-timeout">dashboard set-rest-requests-timeout</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-rgw-api-access-key">dashboard set-rgw-api-access-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-rgw-api-admin-resource">dashboard set-rgw-api-admin-resource</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-rgw-api-secret-key">dashboard set-rgw-api-secret-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-rgw-api-ssl-verify">dashboard set-rgw-api-ssl-verify</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-user-pwd-expiration-span">dashboard set-user-pwd-expiration-span</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-user-pwd-expiration-warning-1">dashboard set-user-pwd-expiration-warning-1</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-set-user-pwd-expiration-warning-2">dashboard set-user-pwd-expiration-warning-2</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-sso-disable">dashboard sso disable</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-sso-enable-saml2">dashboard sso enable saml2</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-sso-setup-saml2">dashboard sso setup saml2</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-sso-show-saml2">dashboard sso show saml2</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dashboard-sso-status">dashboard sso status</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#device">device</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#device-light">device light</a></li>
<li class="toctree-l4"><a class="reference internal" href="#device-ls-lights">device ls-lights</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#fs">fs</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#fs-clone-cancel">fs clone cancel</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-clone-status">fs clone status</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-perf-stats">fs perf stats</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-authorize">fs subvolume authorize</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-authorized-list">fs subvolume authorized_list</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-create">fs subvolume create</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-deauthorize">fs subvolume deauthorize</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-evict">fs subvolume evict</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-getpath">fs subvolume getpath</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-info">fs subvolume info</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-ls">fs subvolume ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-pin">fs subvolume pin</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-resize">fs subvolume resize</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-rm">fs subvolume rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-snapshot-clone">fs subvolume snapshot clone</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-snapshot-create">fs subvolume snapshot create</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-snapshot-info">fs subvolume snapshot info</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-snapshot-ls">fs subvolume snapshot ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-snapshot-protect">fs subvolume snapshot protect</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-snapshot-rm">fs subvolume snapshot rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolume-snapshot-unprotect">fs subvolume snapshot unprotect</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolumegroup-create">fs subvolumegroup create</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolumegroup-getpath">fs subvolumegroup getpath</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolumegroup-ls">fs subvolumegroup ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolumegroup-pin">fs subvolumegroup pin</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolumegroup-rm">fs subvolumegroup rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolumegroup-snapshot-create">fs subvolumegroup snapshot create</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolumegroup-snapshot-ls">fs subvolumegroup snapshot ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-subvolumegroup-snapshot-rm">fs subvolumegroup snapshot rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-volume-create">fs volume create</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-volume-ls">fs volume ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-volume-rename">fs volume rename</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-volume-rm">fs volume rm</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#influx">influx</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#influx-config-set">influx config-set</a></li>
<li class="toctree-l4"><a class="reference internal" href="#influx-config-show">influx config-show</a></li>
<li class="toctree-l4"><a class="reference internal" href="#influx-send">influx send</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#k8sevents">k8sevents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#k8sevents-ceph">k8sevents ceph</a></li>
<li class="toctree-l4"><a class="reference internal" href="#k8sevents-clear-config">k8sevents clear-config</a></li>
<li class="toctree-l4"><a class="reference internal" href="#k8sevents-ls">k8sevents ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#k8sevents-set-access">k8sevents set-access</a></li>
<li class="toctree-l4"><a class="reference internal" href="#k8sevents-set-config">k8sevents set-config</a></li>
<li class="toctree-l4"><a class="reference internal" href="#k8sevents-status">k8sevents status</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#orch">orch</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id1">orch</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-apply">orch apply</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-apply-iscsi">orch apply iscsi</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-apply-mds">orch apply mds</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-apply-nfs">orch apply nfs</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-apply-osd">orch apply osd</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-apply-rgw">orch apply rgw</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-apply-snmp-gateway">orch apply snmp-gateway</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-cancel">orch cancel</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-client-keyring-ls">orch client-keyring ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-client-keyring-rm">orch client-keyring rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-client-keyring-set">orch client-keyring set</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-daemon">orch daemon</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-daemon-add">orch daemon add</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-daemon-add-iscsi">orch daemon add iscsi</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-daemon-add-mds">orch daemon add mds</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-daemon-add-nfs">orch daemon add nfs</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-daemon-add-osd">orch daemon add osd</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-daemon-add-rgw">orch daemon add rgw</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-daemon-redeploy">orch daemon redeploy</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-daemon-rm">orch daemon rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-device-ls">orch device ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-device-zap">orch device zap</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-host-add">orch host add</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-host-drain">orch host drain</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-host-label-add">orch host label add</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-host-label-rm">orch host label rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-host-ls">orch host ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-host-maintenance-enter">orch host maintenance enter</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-host-maintenance-exit">orch host maintenance exit</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-host-ok-to-stop">orch host ok-to-stop</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-host-rm">orch host rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-host-set-addr">orch host set-addr</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-ls">orch ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-osd-rm">orch osd rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-osd-rm-status">orch osd rm status</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-osd-rm-stop">orch osd rm stop</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-pause">orch pause</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-ps">orch ps</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-resume">orch resume</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-rm">orch rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-set-backend">orch set backend</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-status">orch status</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-upgrade-check">orch upgrade check</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-upgrade-ls">orch upgrade ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-upgrade-pause">orch upgrade pause</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-upgrade-resume">orch upgrade resume</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-upgrade-start">orch upgrade start</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-upgrade-status">orch upgrade status</a></li>
<li class="toctree-l4"><a class="reference internal" href="#orch-upgrade-stop">orch upgrade stop</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#osd">osd</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#osd-perf-counters-get">osd perf counters get</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-perf-query-add">osd perf query add</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-perf-query-remove">osd perf query remove</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#progress">progress</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id2">progress</a></li>
<li class="toctree-l4"><a class="reference internal" href="#progress-clear">progress clear</a></li>
<li class="toctree-l4"><a class="reference internal" href="#progress-json">progress json</a></li>
<li class="toctree-l4"><a class="reference internal" href="#progress-off">progress off</a></li>
<li class="toctree-l4"><a class="reference internal" href="#progress-on">progress on</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#restful">restful</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#restful-create-key">restful create-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#restful-create-self-signed-cert">restful create-self-signed-cert</a></li>
<li class="toctree-l4"><a class="reference internal" href="#restful-delete-key">restful delete-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#restful-list-keys">restful list-keys</a></li>
<li class="toctree-l4"><a class="reference internal" href="#restful-restart">restful restart</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#add-bootstrap-peer-hint">add_bootstrap_peer_hint</a></li>
<li class="toctree-l3"><a class="reference internal" href="#add-bootstrap-peer-hintv">add_bootstrap_peer_hintv</a></li>
<li class="toctree-l3"><a class="reference internal" href="#auth">auth</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#auth-add">auth add</a></li>
<li class="toctree-l4"><a class="reference internal" href="#auth-caps">auth caps</a></li>
<li class="toctree-l4"><a class="reference internal" href="#auth-del">auth del</a></li>
<li class="toctree-l4"><a class="reference internal" href="#auth-export">auth export</a></li>
<li class="toctree-l4"><a class="reference internal" href="#auth-get">auth get</a></li>
<li class="toctree-l4"><a class="reference internal" href="#auth-get-key">auth get-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#auth-get-or-create">auth get-or-create</a></li>
<li class="toctree-l4"><a class="reference internal" href="#auth-get-or-create-key">auth get-or-create-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#auth-import">auth import</a></li>
<li class="toctree-l4"><a class="reference internal" href="#auth-list">auth list</a></li>
<li class="toctree-l4"><a class="reference internal" href="#auth-ls">auth ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#auth-print-key">auth print-key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id3">auth print_key</a></li>
<li class="toctree-l4"><a class="reference internal" href="#auth-rm">auth rm</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#compact">compact</a></li>
<li class="toctree-l3"><a class="reference internal" href="#config">config</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#config-assimilate-conf">config assimilate-conf</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-dump">config dump</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-generate-minimal-conf">config generate-minimal-conf</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-get">config get</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-help">config help</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-log">config log</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-ls">config ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-reset">config reset</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-rm">config rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-set">config set</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-show">config show</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-show-with-defaults">config show-with-defaults</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#config-key">config-key</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#config-key-del">config-key del</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-key-dump">config-key dump</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-key-exists">config-key exists</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-key-get">config-key get</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-key-list">config-key list</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-key-ls">config-key ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-key-put">config-key put</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-key-rm">config-key rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#config-key-set">config-key set</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#connection">connection</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#connection-scores-dump">connection scores dump</a></li>
<li class="toctree-l4"><a class="reference internal" href="#connection-scores-reset">connection scores reset</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#id4">device</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#device-info">device info</a></li>
<li class="toctree-l4"><a class="reference internal" href="#device-ls">device ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#device-ls-by-daemon">device ls-by-daemon</a></li>
<li class="toctree-l4"><a class="reference internal" href="#device-ls-by-host">device ls-by-host</a></li>
<li class="toctree-l4"><a class="reference internal" href="#device-rm-life-expectancy">device rm-life-expectancy</a></li>
<li class="toctree-l4"><a class="reference internal" href="#device-set-life-expectancy">device set-life-expectancy</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#df">df</a></li>
<li class="toctree-l3"><a class="reference internal" href="#dump-historic-ops">dump_historic_ops</a></li>
<li class="toctree-l3"><a class="reference internal" href="#features">features</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id5">fs</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#fs-add-data-pool">fs add_data_pool</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-authorize">fs authorize</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-compat">fs compat</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-compat-show">fs compat show</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-dump">fs dump</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-fail">fs fail</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-feature-ls">fs feature ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-flag-set">fs flag set</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-get">fs get</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-ls">fs ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-lsflags">fs lsflags</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-mirror-disable">fs mirror disable</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-mirror-enable">fs mirror enable</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-mirror-peer-add">fs mirror peer_add</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-mirror-peer-remove">fs mirror peer_remove</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-new">fs new</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-rename">fs rename</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-required-client-features">fs required_client_features</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-reset">fs reset</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-rm">fs rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-rm-data-pool">fs rm_data_pool</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-set">fs set</a></li>
<li class="toctree-l4"><a class="reference internal" href="#fs-set-default">fs set-default</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id6">fs set_default</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#fsid">fsid</a></li>
<li class="toctree-l3"><a class="reference internal" href="#health">health</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id7">health</a></li>
<li class="toctree-l4"><a class="reference internal" href="#health-mute">health mute</a></li>
<li class="toctree-l4"><a class="reference internal" href="#health-unmute">health unmute</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#heap">heap</a></li>
<li class="toctree-l3"><a class="reference internal" href="#injectargs">injectargs</a></li>
<li class="toctree-l3"><a class="reference internal" href="#log">log</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id8">log</a></li>
<li class="toctree-l4"><a class="reference internal" href="#log-last">log last</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#mds">mds</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#mds-compat-rm-compat">mds compat rm_compat</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mds-compat-rm-incompat">mds compat rm_incompat</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mds-compat-show">mds compat show</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mds-count-metadata">mds count-metadata</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mds-fail">mds fail</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mds-metadata">mds metadata</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mds-ok-to-stop">mds ok-to-stop</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mds-repaired">mds repaired</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mds-rm">mds rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mds-versions">mds versions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#mgr">mgr</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#mgr-count-metadata">mgr count-metadata</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mgr-dump">mgr dump</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mgr-fail">mgr fail</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mgr-metadata">mgr metadata</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mgr-module-disable">mgr module disable</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mgr-module-enable">mgr module enable</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mgr-module-ls">mgr module ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mgr-services">mgr services</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mgr-stat">mgr stat</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mgr-versions">mgr versions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#mon">mon</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#mon-add">mon add</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-add-disallowed-leader">mon add disallowed_leader</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-count-metadata">mon count-metadata</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-dump">mon dump</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-enable-msgr2">mon enable-msgr2</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-enable-stretch-mode">mon enable_stretch_mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-feature-ls">mon feature ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-feature-set">mon feature set</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-getmap">mon getmap</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-metadata">mon metadata</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-ok-to-add-offline">mon ok-to-add-offline</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-ok-to-rm">mon ok-to-rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-ok-to-stop">mon ok-to-stop</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-remove">mon remove</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-rm">mon rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-rm-disallowed-leader">mon rm disallowed_leader</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-scrub">mon scrub</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-set-election-strategy">mon set election_strategy</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-set-addrs">mon set-addrs</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-set-rank">mon set-rank</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-set-weight">mon set-weight</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-set-location">mon set_location</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-set-new-tiebreaker">mon set_new_tiebreaker</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-stat">mon stat</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mon-versions">mon versions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#mon-status">mon_status</a></li>
<li class="toctree-l3"><a class="reference internal" href="#node-ls">node ls</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ops">ops</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">osd</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#osd-add-nodown">osd add-nodown</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-add-noin">osd add-noin</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-add-noout">osd add-noout</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-add-noup">osd add-noup</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-blacklist">osd blacklist</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-blacklist-clear">osd blacklist clear</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-blacklist-ls">osd blacklist ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-blocked-by">osd blocked-by</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-blocklist">osd blocklist</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-blocklist-clear">osd blocklist clear</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-blocklist-ls">osd blocklist ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-count-metadata">osd count-metadata</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-create">osd create</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-add">osd crush add</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-add-bucket">osd crush add-bucket</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-class-create">osd crush class create</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-class-ls">osd crush class ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-class-ls-osd">osd crush class ls-osd</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-class-rename">osd crush class rename</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-class-rm">osd crush class rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-create-or-move">osd crush create-or-move</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-dump">osd crush dump</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-get-device-class">osd crush get-device-class</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-get-tunable">osd crush get-tunable</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-link">osd crush link</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-ls">osd crush ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-move">osd crush move</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-remove">osd crush remove</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-rename-bucket">osd crush rename-bucket</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-reweight">osd crush reweight</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-reweight-all">osd crush reweight-all</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-reweight-subtree">osd crush reweight-subtree</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-rm">osd crush rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-rm-device-class">osd crush rm-device-class</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-rule-create-erasure">osd crush rule create-erasure</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-rule-create-replicated">osd crush rule create-replicated</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-rule-create-simple">osd crush rule create-simple</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-rule-dump">osd crush rule dump</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-rule-list">osd crush rule list</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-rule-ls">osd crush rule ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-rule-ls-by-class">osd crush rule ls-by-class</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-rule-rename">osd crush rule rename</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-rule-rm">osd crush rule rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-set">osd crush set</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id10">osd crush set</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-set-all-straw-buckets-to-straw2">osd crush set-all-straw-buckets-to-straw2</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-set-device-class">osd crush set-device-class</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-set-tunable">osd crush set-tunable</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-show-tunables">osd crush show-tunables</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-swap-bucket">osd crush swap-bucket</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-tree">osd crush tree</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-tunables">osd crush tunables</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-unlink">osd crush unlink</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-weight-set-create">osd crush weight-set create</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-weight-set-create-compat">osd crush weight-set create-compat</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-weight-set-dump">osd crush weight-set dump</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-weight-set-ls">osd crush weight-set ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-weight-set-reweight">osd crush weight-set reweight</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-weight-set-reweight-compat">osd crush weight-set reweight-compat</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-weight-set-rm">osd crush weight-set rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-crush-weight-set-rm-compat">osd crush weight-set rm-compat</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-deep-scrub">osd deep-scrub</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-destroy">osd destroy</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-df">osd df</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-down">osd down</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-dump">osd dump</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-erasure-code-profile-get">osd erasure-code-profile get</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-erasure-code-profile-ls">osd erasure-code-profile ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-erasure-code-profile-rm">osd erasure-code-profile rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-erasure-code-profile-set">osd erasure-code-profile set</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-find">osd find</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-force-create-pg">osd force-create-pg</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-force-healthy-stretch-mode">osd force_healthy_stretch_mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-force-recovery-stretch-mode">osd force_recovery_stretch_mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-get-require-min-compat-client">osd get-require-min-compat-client</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-getcrushmap">osd getcrushmap</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-getmap">osd getmap</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-getmaxosd">osd getmaxosd</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-in">osd in</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-info">osd info</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-last-stat-seq">osd last-stat-seq</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-lost">osd lost</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-ls">osd ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-ls-tree">osd ls-tree</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-lspools">osd lspools</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-map">osd map</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-metadata">osd metadata</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-new">osd new</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-numa-status">osd numa-status</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-ok-to-stop">osd ok-to-stop</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-out">osd out</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pause">osd pause</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-perf">osd perf</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pg-temp">osd pg-temp</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pg-upmap">osd pg-upmap</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pg-upmap-items">osd pg-upmap-items</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-application-disable">osd pool application disable</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-application-enable">osd pool application enable</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-application-get">osd pool application get</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-application-rm">osd pool application rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-application-set">osd pool application set</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-cancel-force-backfill">osd pool cancel-force-backfill</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-cancel-force-recovery">osd pool cancel-force-recovery</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-create">osd pool create</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-deep-scrub">osd pool deep-scrub</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-delete">osd pool delete</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-force-backfill">osd pool force-backfill</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-force-recovery">osd pool force-recovery</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-get">osd pool get</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-get-quota">osd pool get-quota</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-ls">osd pool ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-mksnap">osd pool mksnap</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-rename">osd pool rename</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-repair">osd pool repair</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-rm">osd pool rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-rmsnap">osd pool rmsnap</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-scrub">osd pool scrub</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-set">osd pool set</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-set-quota">osd pool set-quota</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-pool-stats">osd pool stats</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-primary-affinity">osd primary-affinity</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-primary-temp">osd primary-temp</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-purge">osd purge</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-purge-new">osd purge-new</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-repair">osd repair</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-require-osd-release">osd require-osd-release</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-reweight">osd reweight</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-reweight-by-pg">osd reweight-by-pg</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-reweight-by-utilization">osd reweight-by-utilization</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-reweightn">osd reweightn</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-rm">osd rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-rm-nodown">osd rm-nodown</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-rm-noin">osd rm-noin</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-rm-noout">osd rm-noout</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-rm-noup">osd rm-noup</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-rm-pg-upmap">osd rm-pg-upmap</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-rm-pg-upmap-items">osd rm-pg-upmap-items</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-safe-to-destroy">osd safe-to-destroy</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-scrub">osd scrub</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-set">osd set</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-set-backfillfull-ratio">osd set-backfillfull-ratio</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-set-full-ratio">osd set-full-ratio</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-set-group">osd set-group</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-set-nearfull-ratio">osd set-nearfull-ratio</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-set-require-min-compat-client">osd set-require-min-compat-client</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-setcrushmap">osd setcrushmap</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-setmaxosd">osd setmaxosd</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-stat">osd stat</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-stop">osd stop</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-test-reweight-by-pg">osd test-reweight-by-pg</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-test-reweight-by-utilization">osd test-reweight-by-utilization</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-tier-add">osd tier add</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-tier-add-cache">osd tier add-cache</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-tier-cache-mode">osd tier cache-mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-tier-remove">osd tier remove</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-tier-remove-overlay">osd tier remove-overlay</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-tier-rm">osd tier rm</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-tier-rm-overlay">osd tier rm-overlay</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-tier-set-overlay">osd tier set-overlay</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-tree">osd tree</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-tree-from">osd tree-from</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-unpause">osd unpause</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-unset">osd unset</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-unset-group">osd unset-group</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-utilization">osd utilization</a></li>
<li class="toctree-l4"><a class="reference internal" href="#osd-versions">osd versions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#pg">pg</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#pg-cancel-force-backfill">pg cancel-force-backfill</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-cancel-force-recovery">pg cancel-force-recovery</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-debug">pg debug</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-deep-scrub">pg deep-scrub</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-dump">pg dump</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-dump-json">pg dump_json</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-dump-pools-json">pg dump_pools_json</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-dump-stuck">pg dump_stuck</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-force-backfill">pg force-backfill</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-force-recovery">pg force-recovery</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-getmap">pg getmap</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-ls">pg ls</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-ls-by-osd">pg ls-by-osd</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-ls-by-pool">pg ls-by-pool</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-ls-by-primary">pg ls-by-primary</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-map">pg map</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-repair">pg repair</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-repeer">pg repeer</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-scrub">pg scrub</a></li>
<li class="toctree-l4"><a class="reference internal" href="#pg-stat">pg stat</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#quorum">quorum</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#quorum-enter">quorum enter</a></li>
<li class="toctree-l4"><a class="reference internal" href="#quorum-exit">quorum exit</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#quorum-status">quorum_status</a></li>
<li class="toctree-l3"><a class="reference internal" href="#report">report</a></li>
<li class="toctree-l3"><a class="reference internal" href="#service">service</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#service-dump">service dump</a></li>
<li class="toctree-l4"><a class="reference internal" href="#service-status">service status</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#sessions">sessions</a></li>
<li class="toctree-l3"><a class="reference internal" href="#smart">smart</a></li>
<li class="toctree-l3"><a class="reference internal" href="#status">status</a></li>
<li class="toctree-l3"><a class="reference internal" href="#sync-force">sync_force</a></li>
<li class="toctree-l3"><a class="reference internal" href="#tell">tell</a></li>
<li class="toctree-l3"><a class="reference internal" href="#time-sync-status">time-sync-status</a></li>
<li class="toctree-l3"><a class="reference internal" href="#version">version</a></li>
<li class="toctree-l3"><a class="reference internal" href="#versions">versions</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../architecture/">体系结构</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev/developer_guide/">开发者指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev/internals/">Ceph 内幕</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../governance/">项目管理</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../foundation/">Ceph 基金会</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ceph-volume/">ceph-volume</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../releases/general/">Ceph 版本（总目录）</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../releases/">Ceph 版本（索引）</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../security/">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary/">Ceph 术语</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../jaegertracing/">Tracing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../translation_cn/">中文版翻译资源</a></li>
</ul>

            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../">Ceph</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
<div id="dev-warning" class="admonition note">
  <p class="first admonition-title">Notice</p>
  <p class="last">This document is for a development version of Ceph.</p>
</div>
  <div id="docubetter" align="right" style="padding: 5px; font-weight: bold;">
    <a href="https://pad.ceph.com/p/Report_Documentation_Bugs">Report a Documentation Bug</a>
  </div>

  
  <div class="section" id="cephadm">
<h1>cephadm<a class="headerlink" href="#cephadm" title="Permalink to this headline">¶</a></h1>
<div class="section" id="cephadm-check-host">
<h2>cephadm check-host<a class="headerlink" href="#cephadm-check-host" title="Permalink to this headline">¶</a></h2>
<p>Check whether we can access and manage a remote host</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm check-host my_host my_addr
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>host</strong>: (string)</p></li>
<li><p><strong>addr</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-clear-key">
<h2>cephadm clear-key<a class="headerlink" href="#cephadm-clear-key" title="Permalink to this headline">¶</a></h2>
<p>Clear cluster SSH key</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm clear-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-clear-ssh-config">
<h2>cephadm clear-ssh-config<a class="headerlink" href="#cephadm-clear-ssh-config" title="Permalink to this headline">¶</a></h2>
<p>Clear the ssh_config file</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm clear-ssh-config
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-config-check-disable">
<h2>cephadm config-check disable<a class="headerlink" href="#cephadm-config-check-disable" title="Permalink to this headline">¶</a></h2>
<p>Disable a specific configuration check</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm config-check disable my_check_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>check_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-config-check-enable">
<h2>cephadm config-check enable<a class="headerlink" href="#cephadm-config-check-enable" title="Permalink to this headline">¶</a></h2>
<p>Enable a specific configuration check</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm config-check <span class="nb">enable</span> my_check_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>check_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-config-check-ls">
<h2>cephadm config-check ls<a class="headerlink" href="#cephadm-config-check-ls" title="Permalink to this headline">¶</a></h2>
<p>List the available configuration checks and their current state</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm config-check ls plain
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-config-check-status">
<h2>cephadm config-check status<a class="headerlink" href="#cephadm-config-check-status" title="Permalink to this headline">¶</a></h2>
<p>Show whether the configuration checker feature is enabled/disabled</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm config-check status
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-generate-key">
<h2>cephadm generate-key<a class="headerlink" href="#cephadm-generate-key" title="Permalink to this headline">¶</a></h2>
<p>Generate a cluster SSH key (if not present)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm generate-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-get-extra-ceph-conf">
<h2>cephadm get-extra-ceph-conf<a class="headerlink" href="#cephadm-get-extra-ceph-conf" title="Permalink to this headline">¶</a></h2>
<p>Get extra ceph conf that is appended</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm get-extra-ceph-conf
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-get-pub-key">
<h2>cephadm get-pub-key<a class="headerlink" href="#cephadm-get-pub-key" title="Permalink to this headline">¶</a></h2>
<p>Show SSH public key for connecting to cluster hosts</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm get-pub-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-get-ssh-config">
<h2>cephadm get-ssh-config<a class="headerlink" href="#cephadm-get-ssh-config" title="Permalink to this headline">¶</a></h2>
<p>Returns the ssh config as used by cephadm</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm get-ssh-config
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-get-user">
<h2>cephadm get-user<a class="headerlink" href="#cephadm-get-user" title="Permalink to this headline">¶</a></h2>
<p>Show user for SSHing to cluster hosts</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm get-user
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-osd-activate">
<h2>cephadm osd activate<a class="headerlink" href="#cephadm-osd-activate" title="Permalink to this headline">¶</a></h2>
<p>Start OSD containers for existing OSDs</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm osd activate --host<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>host</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-prepare-host">
<h2>cephadm prepare-host<a class="headerlink" href="#cephadm-prepare-host" title="Permalink to this headline">¶</a></h2>
<p>Prepare a remote host for use with cephadm</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm prepare-host my_host my_addr
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>host</strong>: (string)</p></li>
<li><p><strong>addr</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-registry-login">
<h2>cephadm registry-login<a class="headerlink" href="#cephadm-registry-login" title="Permalink to this headline">¶</a></h2>
<p>Set custom registry login info by providing url, username and password
or json file with login info (-i &lt;file&gt;)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm registry-login my_url my_username my_password
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>url</strong>: (string)</p></li>
<li><p><strong>username</strong>: (string)</p></li>
<li><p><strong>password</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-set-extra-ceph-conf">
<h2>cephadm set-extra-ceph-conf<a class="headerlink" href="#cephadm-set-extra-ceph-conf" title="Permalink to this headline">¶</a></h2>
<p>Text that is appended to all daemon’s ceph.conf. Mainly a workaround,
till <cite>config generate-minimal-conf</cite> generates a complete ceph.conf.
Warning: this is a dangerous operation.</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm set-extra-ceph-conf
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-set-priv-key">
<h2>cephadm set-priv-key<a class="headerlink" href="#cephadm-set-priv-key" title="Permalink to this headline">¶</a></h2>
<p>Set cluster SSH private key (use -i &lt;private_key&gt;)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm set-priv-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-set-pub-key">
<h2>cephadm set-pub-key<a class="headerlink" href="#cephadm-set-pub-key" title="Permalink to this headline">¶</a></h2>
<p>Set cluster SSH public key (use -i &lt;public_key&gt;)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm set-pub-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-set-ssh-config">
<h2>cephadm set-ssh-config<a class="headerlink" href="#cephadm-set-ssh-config" title="Permalink to this headline">¶</a></h2>
<p>Set the ssh_config file (use -i &lt;ssh_config&gt;)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm set-ssh-config
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="cephadm-set-user">
<h2>cephadm set-user<a class="headerlink" href="#cephadm-set-user" title="Permalink to this headline">¶</a></h2>
<p>Set user for SSHing to cluster hosts, passwordless sudo will be needed
for non-root users</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph cephadm set-user my_user
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>user</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="dashboard">
<h1>dashboard<a class="headerlink" href="#dashboard" title="Permalink to this headline">¶</a></h1>
<div class="section" id="dashboard-create-self-signed-cert">
<h2>dashboard create-self-signed-cert<a class="headerlink" href="#dashboard-create-self-signed-cert" title="Permalink to this headline">¶</a></h2>
<p>Create self signed certificate</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard create-self-signed-cert
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-account-lockout-attempts">
<h2>dashboard get-account-lockout-attempts<a class="headerlink" href="#dashboard-get-account-lockout-attempts" title="Permalink to this headline">¶</a></h2>
<p>Get the ACCOUNT_LOCKOUT_ATTEMPTS option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-account-lockout-attempts
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-alertmanager-api-host">
<h2>dashboard get-alertmanager-api-host<a class="headerlink" href="#dashboard-get-alertmanager-api-host" title="Permalink to this headline">¶</a></h2>
<p>Get the ALERTMANAGER_API_HOST option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-alertmanager-api-host
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-alertmanager-api-ssl-verify">
<h2>dashboard get-alertmanager-api-ssl-verify<a class="headerlink" href="#dashboard-get-alertmanager-api-ssl-verify" title="Permalink to this headline">¶</a></h2>
<p>Get the ALERTMANAGER_API_SSL_VERIFY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-alertmanager-api-ssl-verify
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-audit-api-enabled">
<h2>dashboard get-audit-api-enabled<a class="headerlink" href="#dashboard-get-audit-api-enabled" title="Permalink to this headline">¶</a></h2>
<p>Get the AUDIT_API_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-audit-api-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-audit-api-log-payload">
<h2>dashboard get-audit-api-log-payload<a class="headerlink" href="#dashboard-get-audit-api-log-payload" title="Permalink to this headline">¶</a></h2>
<p>Get the AUDIT_API_LOG_PAYLOAD option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-audit-api-log-payload
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-enable-browsable-api">
<h2>dashboard get-enable-browsable-api<a class="headerlink" href="#dashboard-get-enable-browsable-api" title="Permalink to this headline">¶</a></h2>
<p>Get the ENABLE_BROWSABLE_API option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-enable-browsable-api
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-ganesha-clusters-rados-pool-namespace">
<h2>dashboard get-ganesha-clusters-rados-pool-namespace<a class="headerlink" href="#dashboard-get-ganesha-clusters-rados-pool-namespace" title="Permalink to this headline">¶</a></h2>
<p>Get the GANESHA_CLUSTERS_RADOS_POOL_NAMESPACE option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-ganesha-clusters-rados-pool-namespace
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-grafana-api-password">
<h2>dashboard get-grafana-api-password<a class="headerlink" href="#dashboard-get-grafana-api-password" title="Permalink to this headline">¶</a></h2>
<p>Get the GRAFANA_API_PASSWORD option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-grafana-api-password
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-grafana-api-ssl-verify">
<h2>dashboard get-grafana-api-ssl-verify<a class="headerlink" href="#dashboard-get-grafana-api-ssl-verify" title="Permalink to this headline">¶</a></h2>
<p>Get the GRAFANA_API_SSL_VERIFY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-grafana-api-ssl-verify
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-grafana-api-url">
<h2>dashboard get-grafana-api-url<a class="headerlink" href="#dashboard-get-grafana-api-url" title="Permalink to this headline">¶</a></h2>
<p>Get the GRAFANA_API_URL option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-grafana-api-url
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-grafana-api-username">
<h2>dashboard get-grafana-api-username<a class="headerlink" href="#dashboard-get-grafana-api-username" title="Permalink to this headline">¶</a></h2>
<p>Get the GRAFANA_API_USERNAME option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-grafana-api-username
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-grafana-frontend-api-url">
<h2>dashboard get-grafana-frontend-api-url<a class="headerlink" href="#dashboard-get-grafana-frontend-api-url" title="Permalink to this headline">¶</a></h2>
<p>Get the GRAFANA_FRONTEND_API_URL option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-grafana-frontend-api-url
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-grafana-update-dashboards">
<h2>dashboard get-grafana-update-dashboards<a class="headerlink" href="#dashboard-get-grafana-update-dashboards" title="Permalink to this headline">¶</a></h2>
<p>Get the GRAFANA_UPDATE_DASHBOARDS option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-grafana-update-dashboards
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-iscsi-api-ssl-verification">
<h2>dashboard get-iscsi-api-ssl-verification<a class="headerlink" href="#dashboard-get-iscsi-api-ssl-verification" title="Permalink to this headline">¶</a></h2>
<p>Get the ISCSI_API_SSL_VERIFICATION option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-iscsi-api-ssl-verification
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-issue-tracker-api-key">
<h2>dashboard get-issue-tracker-api-key<a class="headerlink" href="#dashboard-get-issue-tracker-api-key" title="Permalink to this headline">¶</a></h2>
<p>Get the ISSUE_TRACKER_API_KEY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-issue-tracker-api-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-jwt-token-ttl">
<h2>dashboard get-jwt-token-ttl<a class="headerlink" href="#dashboard-get-jwt-token-ttl" title="Permalink to this headline">¶</a></h2>
<p>Get the JWT token TTL in seconds</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-jwt-token-ttl
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-prometheus-api-host">
<h2>dashboard get-prometheus-api-host<a class="headerlink" href="#dashboard-get-prometheus-api-host" title="Permalink to this headline">¶</a></h2>
<p>Get the PROMETHEUS_API_HOST option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-prometheus-api-host
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-prometheus-api-ssl-verify">
<h2>dashboard get-prometheus-api-ssl-verify<a class="headerlink" href="#dashboard-get-prometheus-api-ssl-verify" title="Permalink to this headline">¶</a></h2>
<p>Get the PROMETHEUS_API_SSL_VERIFY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-prometheus-api-ssl-verify
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-pwd-policy-check-complexity-enabled">
<h2>dashboard get-pwd-policy-check-complexity-enabled<a class="headerlink" href="#dashboard-get-pwd-policy-check-complexity-enabled" title="Permalink to this headline">¶</a></h2>
<p>Get the PWD_POLICY_CHECK_COMPLEXITY_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-pwd-policy-check-complexity-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-pwd-policy-check-exclusion-list-enabled">
<h2>dashboard get-pwd-policy-check-exclusion-list-enabled<a class="headerlink" href="#dashboard-get-pwd-policy-check-exclusion-list-enabled" title="Permalink to this headline">¶</a></h2>
<p>Get the PWD_POLICY_CHECK_EXCLUSION_LIST_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-pwd-policy-check-exclusion-list-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-pwd-policy-check-length-enabled">
<h2>dashboard get-pwd-policy-check-length-enabled<a class="headerlink" href="#dashboard-get-pwd-policy-check-length-enabled" title="Permalink to this headline">¶</a></h2>
<p>Get the PWD_POLICY_CHECK_LENGTH_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-pwd-policy-check-length-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-pwd-policy-check-oldpwd-enabled">
<h2>dashboard get-pwd-policy-check-oldpwd-enabled<a class="headerlink" href="#dashboard-get-pwd-policy-check-oldpwd-enabled" title="Permalink to this headline">¶</a></h2>
<p>Get the PWD_POLICY_CHECK_OLDPWD_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-pwd-policy-check-oldpwd-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-pwd-policy-check-repetitive-chars-enabled">
<h2>dashboard get-pwd-policy-check-repetitive-chars-enabled<a class="headerlink" href="#dashboard-get-pwd-policy-check-repetitive-chars-enabled" title="Permalink to this headline">¶</a></h2>
<p>Get the PWD_POLICY_CHECK_REPETITIVE_CHARS_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-pwd-policy-check-repetitive-chars-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-pwd-policy-check-sequential-chars-enabled">
<h2>dashboard get-pwd-policy-check-sequential-chars-enabled<a class="headerlink" href="#dashboard-get-pwd-policy-check-sequential-chars-enabled" title="Permalink to this headline">¶</a></h2>
<p>Get the PWD_POLICY_CHECK_SEQUENTIAL_CHARS_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-pwd-policy-check-sequential-chars-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-pwd-policy-check-username-enabled">
<h2>dashboard get-pwd-policy-check-username-enabled<a class="headerlink" href="#dashboard-get-pwd-policy-check-username-enabled" title="Permalink to this headline">¶</a></h2>
<p>Get the PWD_POLICY_CHECK_USERNAME_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-pwd-policy-check-username-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-pwd-policy-enabled">
<h2>dashboard get-pwd-policy-enabled<a class="headerlink" href="#dashboard-get-pwd-policy-enabled" title="Permalink to this headline">¶</a></h2>
<p>Get the PWD_POLICY_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-pwd-policy-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-pwd-policy-exclusion-list">
<h2>dashboard get-pwd-policy-exclusion-list<a class="headerlink" href="#dashboard-get-pwd-policy-exclusion-list" title="Permalink to this headline">¶</a></h2>
<p>Get the PWD_POLICY_EXCLUSION_LIST option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-pwd-policy-exclusion-list
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-pwd-policy-min-complexity">
<h2>dashboard get-pwd-policy-min-complexity<a class="headerlink" href="#dashboard-get-pwd-policy-min-complexity" title="Permalink to this headline">¶</a></h2>
<p>Get the PWD_POLICY_MIN_COMPLEXITY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-pwd-policy-min-complexity
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-pwd-policy-min-length">
<h2>dashboard get-pwd-policy-min-length<a class="headerlink" href="#dashboard-get-pwd-policy-min-length" title="Permalink to this headline">¶</a></h2>
<p>Get the PWD_POLICY_MIN_LENGTH option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-pwd-policy-min-length
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-rest-requests-timeout">
<h2>dashboard get-rest-requests-timeout<a class="headerlink" href="#dashboard-get-rest-requests-timeout" title="Permalink to this headline">¶</a></h2>
<p>Get the REST_REQUESTS_TIMEOUT option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-rest-requests-timeout
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-rgw-api-access-key">
<h2>dashboard get-rgw-api-access-key<a class="headerlink" href="#dashboard-get-rgw-api-access-key" title="Permalink to this headline">¶</a></h2>
<p>Get the RGW_API_ACCESS_KEY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-rgw-api-access-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-rgw-api-admin-resource">
<h2>dashboard get-rgw-api-admin-resource<a class="headerlink" href="#dashboard-get-rgw-api-admin-resource" title="Permalink to this headline">¶</a></h2>
<p>Get the RGW_API_ADMIN_RESOURCE option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-rgw-api-admin-resource
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-rgw-api-secret-key">
<h2>dashboard get-rgw-api-secret-key<a class="headerlink" href="#dashboard-get-rgw-api-secret-key" title="Permalink to this headline">¶</a></h2>
<p>Get the RGW_API_SECRET_KEY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-rgw-api-secret-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-rgw-api-ssl-verify">
<h2>dashboard get-rgw-api-ssl-verify<a class="headerlink" href="#dashboard-get-rgw-api-ssl-verify" title="Permalink to this headline">¶</a></h2>
<p>Get the RGW_API_SSL_VERIFY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-rgw-api-ssl-verify
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-user-pwd-expiration-span">
<h2>dashboard get-user-pwd-expiration-span<a class="headerlink" href="#dashboard-get-user-pwd-expiration-span" title="Permalink to this headline">¶</a></h2>
<p>Get the USER_PWD_EXPIRATION_SPAN option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-user-pwd-expiration-span
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-user-pwd-expiration-warning-1">
<h2>dashboard get-user-pwd-expiration-warning-1<a class="headerlink" href="#dashboard-get-user-pwd-expiration-warning-1" title="Permalink to this headline">¶</a></h2>
<p>Get the USER_PWD_EXPIRATION_WARNING_1 option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-user-pwd-expiration-warning-1
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-get-user-pwd-expiration-warning-2">
<h2>dashboard get-user-pwd-expiration-warning-2<a class="headerlink" href="#dashboard-get-user-pwd-expiration-warning-2" title="Permalink to this headline">¶</a></h2>
<p>Get the USER_PWD_EXPIRATION_WARNING_2 option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard get-user-pwd-expiration-warning-2
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-grafana-dashboards-update">
<h2>dashboard grafana dashboards update<a class="headerlink" href="#dashboard-grafana-dashboards-update" title="Permalink to this headline">¶</a></h2>
<p>Push dashboards to Grafana</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard grafana dashboards update
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-account-lockout-attempts">
<h2>dashboard reset-account-lockout-attempts<a class="headerlink" href="#dashboard-reset-account-lockout-attempts" title="Permalink to this headline">¶</a></h2>
<p>Reset the ACCOUNT_LOCKOUT_ATTEMPTS option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-account-lockout-attempts
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-alertmanager-api-host">
<h2>dashboard reset-alertmanager-api-host<a class="headerlink" href="#dashboard-reset-alertmanager-api-host" title="Permalink to this headline">¶</a></h2>
<p>Reset the ALERTMANAGER_API_HOST option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-alertmanager-api-host
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-alertmanager-api-ssl-verify">
<h2>dashboard reset-alertmanager-api-ssl-verify<a class="headerlink" href="#dashboard-reset-alertmanager-api-ssl-verify" title="Permalink to this headline">¶</a></h2>
<p>Reset the ALERTMANAGER_API_SSL_VERIFY option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-alertmanager-api-ssl-verify
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-audit-api-enabled">
<h2>dashboard reset-audit-api-enabled<a class="headerlink" href="#dashboard-reset-audit-api-enabled" title="Permalink to this headline">¶</a></h2>
<p>Reset the AUDIT_API_ENABLED option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-audit-api-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-audit-api-log-payload">
<h2>dashboard reset-audit-api-log-payload<a class="headerlink" href="#dashboard-reset-audit-api-log-payload" title="Permalink to this headline">¶</a></h2>
<p>Reset the AUDIT_API_LOG_PAYLOAD option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-audit-api-log-payload
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-enable-browsable-api">
<h2>dashboard reset-enable-browsable-api<a class="headerlink" href="#dashboard-reset-enable-browsable-api" title="Permalink to this headline">¶</a></h2>
<p>Reset the ENABLE_BROWSABLE_API option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-enable-browsable-api
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-ganesha-clusters-rados-pool-namespace">
<h2>dashboard reset-ganesha-clusters-rados-pool-namespace<a class="headerlink" href="#dashboard-reset-ganesha-clusters-rados-pool-namespace" title="Permalink to this headline">¶</a></h2>
<p>Reset the GANESHA_CLUSTERS_RADOS_POOL_NAMESPACE option to its default
value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-ganesha-clusters-rados-pool-namespace
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-grafana-api-password">
<h2>dashboard reset-grafana-api-password<a class="headerlink" href="#dashboard-reset-grafana-api-password" title="Permalink to this headline">¶</a></h2>
<p>Reset the GRAFANA_API_PASSWORD option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-grafana-api-password
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-grafana-api-ssl-verify">
<h2>dashboard reset-grafana-api-ssl-verify<a class="headerlink" href="#dashboard-reset-grafana-api-ssl-verify" title="Permalink to this headline">¶</a></h2>
<p>Reset the GRAFANA_API_SSL_VERIFY option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-grafana-api-ssl-verify
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-grafana-api-url">
<h2>dashboard reset-grafana-api-url<a class="headerlink" href="#dashboard-reset-grafana-api-url" title="Permalink to this headline">¶</a></h2>
<p>Reset the GRAFANA_API_URL option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-grafana-api-url
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-grafana-api-username">
<h2>dashboard reset-grafana-api-username<a class="headerlink" href="#dashboard-reset-grafana-api-username" title="Permalink to this headline">¶</a></h2>
<p>Reset the GRAFANA_API_USERNAME option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-grafana-api-username
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-grafana-frontend-api-url">
<h2>dashboard reset-grafana-frontend-api-url<a class="headerlink" href="#dashboard-reset-grafana-frontend-api-url" title="Permalink to this headline">¶</a></h2>
<p>Reset the GRAFANA_FRONTEND_API_URL option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-grafana-frontend-api-url
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-grafana-update-dashboards">
<h2>dashboard reset-grafana-update-dashboards<a class="headerlink" href="#dashboard-reset-grafana-update-dashboards" title="Permalink to this headline">¶</a></h2>
<p>Reset the GRAFANA_UPDATE_DASHBOARDS option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-grafana-update-dashboards
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-iscsi-api-ssl-verification">
<h2>dashboard reset-iscsi-api-ssl-verification<a class="headerlink" href="#dashboard-reset-iscsi-api-ssl-verification" title="Permalink to this headline">¶</a></h2>
<p>Reset the ISCSI_API_SSL_VERIFICATION option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-iscsi-api-ssl-verification
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-issue-tracker-api-key">
<h2>dashboard reset-issue-tracker-api-key<a class="headerlink" href="#dashboard-reset-issue-tracker-api-key" title="Permalink to this headline">¶</a></h2>
<p>Reset the ISSUE_TRACKER_API_KEY option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-issue-tracker-api-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-prometheus-api-host">
<h2>dashboard reset-prometheus-api-host<a class="headerlink" href="#dashboard-reset-prometheus-api-host" title="Permalink to this headline">¶</a></h2>
<p>Reset the PROMETHEUS_API_HOST option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-prometheus-api-host
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-prometheus-api-ssl-verify">
<h2>dashboard reset-prometheus-api-ssl-verify<a class="headerlink" href="#dashboard-reset-prometheus-api-ssl-verify" title="Permalink to this headline">¶</a></h2>
<p>Reset the PROMETHEUS_API_SSL_VERIFY option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-prometheus-api-ssl-verify
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-pwd-policy-check-complexity-enabled">
<h2>dashboard reset-pwd-policy-check-complexity-enabled<a class="headerlink" href="#dashboard-reset-pwd-policy-check-complexity-enabled" title="Permalink to this headline">¶</a></h2>
<p>Reset the PWD_POLICY_CHECK_COMPLEXITY_ENABLED option to its default
value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-pwd-policy-check-complexity-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-pwd-policy-check-exclusion-list-enabled">
<h2>dashboard reset-pwd-policy-check-exclusion-list-enabled<a class="headerlink" href="#dashboard-reset-pwd-policy-check-exclusion-list-enabled" title="Permalink to this headline">¶</a></h2>
<p>Reset the PWD_POLICY_CHECK_EXCLUSION_LIST_ENABLED option to its
default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-pwd-policy-check-exclusion-list-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-pwd-policy-check-length-enabled">
<h2>dashboard reset-pwd-policy-check-length-enabled<a class="headerlink" href="#dashboard-reset-pwd-policy-check-length-enabled" title="Permalink to this headline">¶</a></h2>
<p>Reset the PWD_POLICY_CHECK_LENGTH_ENABLED option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-pwd-policy-check-length-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-pwd-policy-check-oldpwd-enabled">
<h2>dashboard reset-pwd-policy-check-oldpwd-enabled<a class="headerlink" href="#dashboard-reset-pwd-policy-check-oldpwd-enabled" title="Permalink to this headline">¶</a></h2>
<p>Reset the PWD_POLICY_CHECK_OLDPWD_ENABLED option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-pwd-policy-check-oldpwd-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-pwd-policy-check-repetitive-chars-enabled">
<h2>dashboard reset-pwd-policy-check-repetitive-chars-enabled<a class="headerlink" href="#dashboard-reset-pwd-policy-check-repetitive-chars-enabled" title="Permalink to this headline">¶</a></h2>
<p>Reset the PWD_POLICY_CHECK_REPETITIVE_CHARS_ENABLED option to its
default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-pwd-policy-check-repetitive-chars-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-pwd-policy-check-sequential-chars-enabled">
<h2>dashboard reset-pwd-policy-check-sequential-chars-enabled<a class="headerlink" href="#dashboard-reset-pwd-policy-check-sequential-chars-enabled" title="Permalink to this headline">¶</a></h2>
<p>Reset the PWD_POLICY_CHECK_SEQUENTIAL_CHARS_ENABLED option to its
default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-pwd-policy-check-sequential-chars-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-pwd-policy-check-username-enabled">
<h2>dashboard reset-pwd-policy-check-username-enabled<a class="headerlink" href="#dashboard-reset-pwd-policy-check-username-enabled" title="Permalink to this headline">¶</a></h2>
<p>Reset the PWD_POLICY_CHECK_USERNAME_ENABLED option to its default
value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-pwd-policy-check-username-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-pwd-policy-enabled">
<h2>dashboard reset-pwd-policy-enabled<a class="headerlink" href="#dashboard-reset-pwd-policy-enabled" title="Permalink to this headline">¶</a></h2>
<p>Reset the PWD_POLICY_ENABLED option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-pwd-policy-enabled
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-pwd-policy-exclusion-list">
<h2>dashboard reset-pwd-policy-exclusion-list<a class="headerlink" href="#dashboard-reset-pwd-policy-exclusion-list" title="Permalink to this headline">¶</a></h2>
<p>Reset the PWD_POLICY_EXCLUSION_LIST option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-pwd-policy-exclusion-list
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-pwd-policy-min-complexity">
<h2>dashboard reset-pwd-policy-min-complexity<a class="headerlink" href="#dashboard-reset-pwd-policy-min-complexity" title="Permalink to this headline">¶</a></h2>
<p>Reset the PWD_POLICY_MIN_COMPLEXITY option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-pwd-policy-min-complexity
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-pwd-policy-min-length">
<h2>dashboard reset-pwd-policy-min-length<a class="headerlink" href="#dashboard-reset-pwd-policy-min-length" title="Permalink to this headline">¶</a></h2>
<p>Reset the PWD_POLICY_MIN_LENGTH option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-pwd-policy-min-length
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-rest-requests-timeout">
<h2>dashboard reset-rest-requests-timeout<a class="headerlink" href="#dashboard-reset-rest-requests-timeout" title="Permalink to this headline">¶</a></h2>
<p>Reset the REST_REQUESTS_TIMEOUT option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-rest-requests-timeout
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-rgw-api-access-key">
<h2>dashboard reset-rgw-api-access-key<a class="headerlink" href="#dashboard-reset-rgw-api-access-key" title="Permalink to this headline">¶</a></h2>
<p>Reset the RGW_API_ACCESS_KEY option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-rgw-api-access-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-rgw-api-admin-resource">
<h2>dashboard reset-rgw-api-admin-resource<a class="headerlink" href="#dashboard-reset-rgw-api-admin-resource" title="Permalink to this headline">¶</a></h2>
<p>Reset the RGW_API_ADMIN_RESOURCE option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-rgw-api-admin-resource
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-rgw-api-secret-key">
<h2>dashboard reset-rgw-api-secret-key<a class="headerlink" href="#dashboard-reset-rgw-api-secret-key" title="Permalink to this headline">¶</a></h2>
<p>Reset the RGW_API_SECRET_KEY option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-rgw-api-secret-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-rgw-api-ssl-verify">
<h2>dashboard reset-rgw-api-ssl-verify<a class="headerlink" href="#dashboard-reset-rgw-api-ssl-verify" title="Permalink to this headline">¶</a></h2>
<p>Reset the RGW_API_SSL_VERIFY option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-rgw-api-ssl-verify
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-user-pwd-expiration-span">
<h2>dashboard reset-user-pwd-expiration-span<a class="headerlink" href="#dashboard-reset-user-pwd-expiration-span" title="Permalink to this headline">¶</a></h2>
<p>Reset the USER_PWD_EXPIRATION_SPAN option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-user-pwd-expiration-span
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-user-pwd-expiration-warning-1">
<h2>dashboard reset-user-pwd-expiration-warning-1<a class="headerlink" href="#dashboard-reset-user-pwd-expiration-warning-1" title="Permalink to this headline">¶</a></h2>
<p>Reset the USER_PWD_EXPIRATION_WARNING_1 option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-user-pwd-expiration-warning-1
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-reset-user-pwd-expiration-warning-2">
<h2>dashboard reset-user-pwd-expiration-warning-2<a class="headerlink" href="#dashboard-reset-user-pwd-expiration-warning-2" title="Permalink to this headline">¶</a></h2>
<p>Reset the USER_PWD_EXPIRATION_WARNING_2 option to its default value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard reset-user-pwd-expiration-warning-2
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-account-lockout-attempts">
<h2>dashboard set-account-lockout-attempts<a class="headerlink" href="#dashboard-set-account-lockout-attempts" title="Permalink to this headline">¶</a></h2>
<p>Set the ACCOUNT_LOCKOUT_ATTEMPTS option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-account-lockout-attempts my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-alertmanager-api-host">
<h2>dashboard set-alertmanager-api-host<a class="headerlink" href="#dashboard-set-alertmanager-api-host" title="Permalink to this headline">¶</a></h2>
<p>Set the ALERTMANAGER_API_HOST option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-alertmanager-api-host my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-alertmanager-api-ssl-verify">
<h2>dashboard set-alertmanager-api-ssl-verify<a class="headerlink" href="#dashboard-set-alertmanager-api-ssl-verify" title="Permalink to this headline">¶</a></h2>
<p>Set the ALERTMANAGER_API_SSL_VERIFY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-alertmanager-api-ssl-verify my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-audit-api-enabled">
<h2>dashboard set-audit-api-enabled<a class="headerlink" href="#dashboard-set-audit-api-enabled" title="Permalink to this headline">¶</a></h2>
<p>Set the AUDIT_API_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-audit-api-enabled my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-audit-api-log-payload">
<h2>dashboard set-audit-api-log-payload<a class="headerlink" href="#dashboard-set-audit-api-log-payload" title="Permalink to this headline">¶</a></h2>
<p>Set the AUDIT_API_LOG_PAYLOAD option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-audit-api-log-payload my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-enable-browsable-api">
<h2>dashboard set-enable-browsable-api<a class="headerlink" href="#dashboard-set-enable-browsable-api" title="Permalink to this headline">¶</a></h2>
<p>Set the ENABLE_BROWSABLE_API option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-enable-browsable-api my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-ganesha-clusters-rados-pool-namespace">
<h2>dashboard set-ganesha-clusters-rados-pool-namespace<a class="headerlink" href="#dashboard-set-ganesha-clusters-rados-pool-namespace" title="Permalink to this headline">¶</a></h2>
<p>Set the GANESHA_CLUSTERS_RADOS_POOL_NAMESPACE option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-ganesha-clusters-rados-pool-namespace my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-grafana-api-password">
<h2>dashboard set-grafana-api-password<a class="headerlink" href="#dashboard-set-grafana-api-password" title="Permalink to this headline">¶</a></h2>
<p>Set the GRAFANA_API_PASSWORD option value read from -i &lt;file&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-grafana-api-password
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-grafana-api-ssl-verify">
<h2>dashboard set-grafana-api-ssl-verify<a class="headerlink" href="#dashboard-set-grafana-api-ssl-verify" title="Permalink to this headline">¶</a></h2>
<p>Set the GRAFANA_API_SSL_VERIFY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-grafana-api-ssl-verify my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-grafana-api-url">
<h2>dashboard set-grafana-api-url<a class="headerlink" href="#dashboard-set-grafana-api-url" title="Permalink to this headline">¶</a></h2>
<p>Set the GRAFANA_API_URL option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-grafana-api-url my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-grafana-api-username">
<h2>dashboard set-grafana-api-username<a class="headerlink" href="#dashboard-set-grafana-api-username" title="Permalink to this headline">¶</a></h2>
<p>Set the GRAFANA_API_USERNAME option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-grafana-api-username my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-grafana-frontend-api-url">
<h2>dashboard set-grafana-frontend-api-url<a class="headerlink" href="#dashboard-set-grafana-frontend-api-url" title="Permalink to this headline">¶</a></h2>
<p>Set the GRAFANA_FRONTEND_API_URL option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-grafana-frontend-api-url my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-grafana-update-dashboards">
<h2>dashboard set-grafana-update-dashboards<a class="headerlink" href="#dashboard-set-grafana-update-dashboards" title="Permalink to this headline">¶</a></h2>
<p>Set the GRAFANA_UPDATE_DASHBOARDS option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-grafana-update-dashboards my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-iscsi-api-ssl-verification">
<h2>dashboard set-iscsi-api-ssl-verification<a class="headerlink" href="#dashboard-set-iscsi-api-ssl-verification" title="Permalink to this headline">¶</a></h2>
<p>Set the ISCSI_API_SSL_VERIFICATION option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-iscsi-api-ssl-verification my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-issue-tracker-api-key">
<h2>dashboard set-issue-tracker-api-key<a class="headerlink" href="#dashboard-set-issue-tracker-api-key" title="Permalink to this headline">¶</a></h2>
<p>Set the ISSUE_TRACKER_API_KEY option value read from -i &lt;file&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-issue-tracker-api-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-jwt-token-ttl">
<h2>dashboard set-jwt-token-ttl<a class="headerlink" href="#dashboard-set-jwt-token-ttl" title="Permalink to this headline">¶</a></h2>
<p>Set the JWT token TTL in seconds</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-jwt-token-ttl <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>seconds</strong>: CephInt</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-prometheus-api-host">
<h2>dashboard set-prometheus-api-host<a class="headerlink" href="#dashboard-set-prometheus-api-host" title="Permalink to this headline">¶</a></h2>
<p>Set the PROMETHEUS_API_HOST option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-prometheus-api-host my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-prometheus-api-ssl-verify">
<h2>dashboard set-prometheus-api-ssl-verify<a class="headerlink" href="#dashboard-set-prometheus-api-ssl-verify" title="Permalink to this headline">¶</a></h2>
<p>Set the PROMETHEUS_API_SSL_VERIFY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-prometheus-api-ssl-verify my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-pwd-policy-check-complexity-enabled">
<h2>dashboard set-pwd-policy-check-complexity-enabled<a class="headerlink" href="#dashboard-set-pwd-policy-check-complexity-enabled" title="Permalink to this headline">¶</a></h2>
<p>Set the PWD_POLICY_CHECK_COMPLEXITY_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-pwd-policy-check-complexity-enabled my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-pwd-policy-check-exclusion-list-enabled">
<h2>dashboard set-pwd-policy-check-exclusion-list-enabled<a class="headerlink" href="#dashboard-set-pwd-policy-check-exclusion-list-enabled" title="Permalink to this headline">¶</a></h2>
<p>Set the PWD_POLICY_CHECK_EXCLUSION_LIST_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-pwd-policy-check-exclusion-list-enabled my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-pwd-policy-check-length-enabled">
<h2>dashboard set-pwd-policy-check-length-enabled<a class="headerlink" href="#dashboard-set-pwd-policy-check-length-enabled" title="Permalink to this headline">¶</a></h2>
<p>Set the PWD_POLICY_CHECK_LENGTH_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-pwd-policy-check-length-enabled my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-pwd-policy-check-oldpwd-enabled">
<h2>dashboard set-pwd-policy-check-oldpwd-enabled<a class="headerlink" href="#dashboard-set-pwd-policy-check-oldpwd-enabled" title="Permalink to this headline">¶</a></h2>
<p>Set the PWD_POLICY_CHECK_OLDPWD_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-pwd-policy-check-oldpwd-enabled my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-pwd-policy-check-repetitive-chars-enabled">
<h2>dashboard set-pwd-policy-check-repetitive-chars-enabled<a class="headerlink" href="#dashboard-set-pwd-policy-check-repetitive-chars-enabled" title="Permalink to this headline">¶</a></h2>
<p>Set the PWD_POLICY_CHECK_REPETITIVE_CHARS_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-pwd-policy-check-repetitive-chars-enabled my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-pwd-policy-check-sequential-chars-enabled">
<h2>dashboard set-pwd-policy-check-sequential-chars-enabled<a class="headerlink" href="#dashboard-set-pwd-policy-check-sequential-chars-enabled" title="Permalink to this headline">¶</a></h2>
<p>Set the PWD_POLICY_CHECK_SEQUENTIAL_CHARS_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-pwd-policy-check-sequential-chars-enabled my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-pwd-policy-check-username-enabled">
<h2>dashboard set-pwd-policy-check-username-enabled<a class="headerlink" href="#dashboard-set-pwd-policy-check-username-enabled" title="Permalink to this headline">¶</a></h2>
<p>Set the PWD_POLICY_CHECK_USERNAME_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-pwd-policy-check-username-enabled my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-pwd-policy-enabled">
<h2>dashboard set-pwd-policy-enabled<a class="headerlink" href="#dashboard-set-pwd-policy-enabled" title="Permalink to this headline">¶</a></h2>
<p>Set the PWD_POLICY_ENABLED option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-pwd-policy-enabled my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-pwd-policy-exclusion-list">
<h2>dashboard set-pwd-policy-exclusion-list<a class="headerlink" href="#dashboard-set-pwd-policy-exclusion-list" title="Permalink to this headline">¶</a></h2>
<p>Set the PWD_POLICY_EXCLUSION_LIST option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-pwd-policy-exclusion-list my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-pwd-policy-min-complexity">
<h2>dashboard set-pwd-policy-min-complexity<a class="headerlink" href="#dashboard-set-pwd-policy-min-complexity" title="Permalink to this headline">¶</a></h2>
<p>Set the PWD_POLICY_MIN_COMPLEXITY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-pwd-policy-min-complexity my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-pwd-policy-min-length">
<h2>dashboard set-pwd-policy-min-length<a class="headerlink" href="#dashboard-set-pwd-policy-min-length" title="Permalink to this headline">¶</a></h2>
<p>Set the PWD_POLICY_MIN_LENGTH option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-pwd-policy-min-length my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-rest-requests-timeout">
<h2>dashboard set-rest-requests-timeout<a class="headerlink" href="#dashboard-set-rest-requests-timeout" title="Permalink to this headline">¶</a></h2>
<p>Set the REST_REQUESTS_TIMEOUT option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-rest-requests-timeout my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-rgw-api-access-key">
<h2>dashboard set-rgw-api-access-key<a class="headerlink" href="#dashboard-set-rgw-api-access-key" title="Permalink to this headline">¶</a></h2>
<p>Set the RGW_API_ACCESS_KEY option value read from -i &lt;file&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-rgw-api-access-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-rgw-api-admin-resource">
<h2>dashboard set-rgw-api-admin-resource<a class="headerlink" href="#dashboard-set-rgw-api-admin-resource" title="Permalink to this headline">¶</a></h2>
<p>Set the RGW_API_ADMIN_RESOURCE option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-rgw-api-admin-resource my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-rgw-api-secret-key">
<h2>dashboard set-rgw-api-secret-key<a class="headerlink" href="#dashboard-set-rgw-api-secret-key" title="Permalink to this headline">¶</a></h2>
<p>Set the RGW_API_SECRET_KEY option value read from -i &lt;file&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-rgw-api-secret-key
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-rgw-api-ssl-verify">
<h2>dashboard set-rgw-api-ssl-verify<a class="headerlink" href="#dashboard-set-rgw-api-ssl-verify" title="Permalink to this headline">¶</a></h2>
<p>Set the RGW_API_SSL_VERIFY option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-rgw-api-ssl-verify my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-user-pwd-expiration-span">
<h2>dashboard set-user-pwd-expiration-span<a class="headerlink" href="#dashboard-set-user-pwd-expiration-span" title="Permalink to this headline">¶</a></h2>
<p>Set the USER_PWD_EXPIRATION_SPAN option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-user-pwd-expiration-span my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-user-pwd-expiration-warning-1">
<h2>dashboard set-user-pwd-expiration-warning-1<a class="headerlink" href="#dashboard-set-user-pwd-expiration-warning-1" title="Permalink to this headline">¶</a></h2>
<p>Set the USER_PWD_EXPIRATION_WARNING_1 option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-user-pwd-expiration-warning-1 my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-set-user-pwd-expiration-warning-2">
<h2>dashboard set-user-pwd-expiration-warning-2<a class="headerlink" href="#dashboard-set-user-pwd-expiration-warning-2" title="Permalink to this headline">¶</a></h2>
<p>Set the USER_PWD_EXPIRATION_WARNING_2 option value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard set-user-pwd-expiration-warning-2 my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-sso-disable">
<h2>dashboard sso disable<a class="headerlink" href="#dashboard-sso-disable" title="Permalink to this headline">¶</a></h2>
<p>Disable Single Sign-On</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard sso disable
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-sso-enable-saml2">
<h2>dashboard sso enable saml2<a class="headerlink" href="#dashboard-sso-enable-saml2" title="Permalink to this headline">¶</a></h2>
<p>Enable SAML2 Single Sign-On</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard sso <span class="nb">enable</span> saml2
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-sso-setup-saml2">
<h2>dashboard sso setup saml2<a class="headerlink" href="#dashboard-sso-setup-saml2" title="Permalink to this headline">¶</a></h2>
<p>Setup SAML2 Single Sign-On</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard sso setup saml2 --ceph_dashboard_base_url<span class="o">=</span>string
  --idp_metadata<span class="o">=</span>string --idp_username_attribute<span class="o">=</span>string
  --idp_entity_id<span class="o">=</span>string --sp_x_509_cert<span class="o">=</span>/path/to/file
  --sp_private_key<span class="o">=</span>/path/to/file
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ceph_dashboard_base_url</strong>: (string)</p></li>
<li><p><strong>idp_metadata</strong>: (string)</p></li>
<li><p><strong>idp_username_attribute</strong>: (string)</p></li>
<li><p><strong>idp_entity_id</strong>: (string)</p></li>
<li><p><strong>sp_x_509_cert</strong>: CephFilepath</p></li>
<li><p><strong>sp_private_key</strong>: CephFilepath</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-sso-show-saml2">
<h2>dashboard sso show saml2<a class="headerlink" href="#dashboard-sso-show-saml2" title="Permalink to this headline">¶</a></h2>
<p>Show SAML2 configuration</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard sso show saml2
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dashboard-sso-status">
<h2>dashboard sso status<a class="headerlink" href="#dashboard-sso-status" title="Permalink to this headline">¶</a></h2>
<p>Get Single Sign-On status</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dashboard sso status
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="device">
<h1>device<a class="headerlink" href="#device" title="Permalink to this headline">¶</a></h1>
<div class="section" id="device-light">
<h2>device light<a class="headerlink" href="#device-light" title="Permalink to this headline">¶</a></h2>
<p>Enable or disable the device light. Default type is <cite>ident</cite> ‘Usage:
device light (on|off) &lt;devid&gt; [ident|fault] [–force]’</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph device light --enable<span class="o">=</span>on --devid<span class="o">=</span>string --light_type<span class="o">=</span>ident
  --force
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>enable</strong>: CephChoices  strings=(on off)</p></li>
<li><p><strong>devid</strong>: (string)</p></li>
<li><p><strong>light_type</strong>: CephChoices  strings=(ident fault)</p></li>
<li><p><strong>–force</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="device-ls-lights">
<h2>device ls-lights<a class="headerlink" href="#device-ls-lights" title="Permalink to this headline">¶</a></h2>
<p>List currently active device indicator lights</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph device ls-lights
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="fs">
<h1>fs<a class="headerlink" href="#fs" title="Permalink to this headline">¶</a></h1>
<div class="section" id="fs-clone-cancel">
<h2>fs clone cancel<a class="headerlink" href="#fs-clone-cancel" title="Permalink to this headline">¶</a></h2>
<p>Cancel an pending or ongoing clone operation.</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs clone cancel my_vol_name my_clone_name my_group_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>clone_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-clone-status">
<h2>fs clone status<a class="headerlink" href="#fs-clone-status" title="Permalink to this headline">¶</a></h2>
<p>Get status on a cloned subvolume.</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs clone status my_vol_name my_clone_name my_group_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>clone_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-perf-stats">
<h2>fs perf stats<a class="headerlink" href="#fs-perf-stats" title="Permalink to this headline">¶</a></h2>
<p>retrieve ceph fs performance stats</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs perf stats my_mds_rank my_client_id my_client_ip
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>mds_rank</strong>: (string)</p></li>
<li><p><strong>client_id</strong>: (string)</p></li>
<li><p><strong>client_ip</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-authorize">
<h2>fs subvolume authorize<a class="headerlink" href="#fs-subvolume-authorize" title="Permalink to this headline">¶</a></h2>
<p>Allow a cephx auth ID access to a subvolume</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume authorize --vol_name<span class="o">=</span>string --sub_name<span class="o">=</span>string
  --auth_id<span class="o">=</span>string --group_name<span class="o">=</span>string --access_level<span class="o">=</span>string
  --tenant_id<span class="o">=</span>string --allow_existing_id
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>auth_id</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
<li><p><strong>access_level</strong>: (string)</p></li>
<li><p><strong>tenant_id</strong>: (string)</p></li>
<li><p><strong>allow_existing_id</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-authorized-list">
<h2>fs subvolume authorized_list<a class="headerlink" href="#fs-subvolume-authorized-list" title="Permalink to this headline">¶</a></h2>
<p>List auth IDs that have access to a subvolume</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume authorized_list my_vol_name my_sub_name
  my_group_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-create">
<h2>fs subvolume create<a class="headerlink" href="#fs-subvolume-create" title="Permalink to this headline">¶</a></h2>
<p>Create a CephFS subvolume in a volume, and optionally, with a specific
size (in bytes), a specific data pool layout, a specific mode, in a
specific subvolume group and in separate RADOS namespace</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume create --vol_name<span class="o">=</span>string --sub_name<span class="o">=</span>string --size<span class="o">=</span><span class="m">1</span>
  --group_name<span class="o">=</span>string --pool_layout<span class="o">=</span>string --uid<span class="o">=</span><span class="m">1</span> --gid<span class="o">=</span><span class="m">1</span> --mode<span class="o">=</span>string
  --namespace_isolated
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>size</strong>: CephInt</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
<li><p><strong>pool_layout</strong>: (string)</p></li>
<li><p><strong>uid</strong>: CephInt</p></li>
<li><p><strong>gid</strong>: CephInt</p></li>
<li><p><strong>mode</strong>: (string)</p></li>
<li><p><strong>namespace_isolated</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-deauthorize">
<h2>fs subvolume deauthorize<a class="headerlink" href="#fs-subvolume-deauthorize" title="Permalink to this headline">¶</a></h2>
<p>Deny a cephx auth ID access to a subvolume</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume deauthorize --vol_name<span class="o">=</span>string --sub_name<span class="o">=</span>string
  --auth_id<span class="o">=</span>string --group_name<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>auth_id</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-evict">
<h2>fs subvolume evict<a class="headerlink" href="#fs-subvolume-evict" title="Permalink to this headline">¶</a></h2>
<p>Evict clients based on auth IDs and subvolume mounted</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume evict --vol_name<span class="o">=</span>string --sub_name<span class="o">=</span>string
  --auth_id<span class="o">=</span>string --group_name<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>auth_id</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-getpath">
<h2>fs subvolume getpath<a class="headerlink" href="#fs-subvolume-getpath" title="Permalink to this headline">¶</a></h2>
<p>Get the mountpath of a CephFS subvolume in a volume, and optionally,
in a specific subvolume group</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume getpath my_vol_name my_sub_name my_group_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-info">
<h2>fs subvolume info<a class="headerlink" href="#fs-subvolume-info" title="Permalink to this headline">¶</a></h2>
<p>Get the metadata of a CephFS subvolume in a volume, and optionally, in
a specific subvolume group</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume info my_vol_name my_sub_name my_group_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-ls">
<h2>fs subvolume ls<a class="headerlink" href="#fs-subvolume-ls" title="Permalink to this headline">¶</a></h2>
<p>List subvolumes</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume ls my_vol_name my_group_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-pin">
<h2>fs subvolume pin<a class="headerlink" href="#fs-subvolume-pin" title="Permalink to this headline">¶</a></h2>
<p>Set MDS pinning policy for subvolume</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume pin --vol_name<span class="o">=</span>string --sub_name<span class="o">=</span>string
  --pin_type<span class="o">=</span><span class="nb">export</span> --pin_setting<span class="o">=</span>string --group_name<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>pin_type</strong>: CephChoices  strings=(export distributed random)</p></li>
<li><p><strong>pin_setting</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-resize">
<h2>fs subvolume resize<a class="headerlink" href="#fs-subvolume-resize" title="Permalink to this headline">¶</a></h2>
<p>Resize a CephFS subvolume</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume resize --vol_name<span class="o">=</span>string --sub_name<span class="o">=</span>string
  --new_size<span class="o">=</span>string --group_name<span class="o">=</span>string --no_shrink
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>new_size</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
<li><p><strong>no_shrink</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-rm">
<h2>fs subvolume rm<a class="headerlink" href="#fs-subvolume-rm" title="Permalink to this headline">¶</a></h2>
<p>Delete a CephFS subvolume in a volume, and optionally, in a specific
subvolume group, force deleting a cancelled or failed clone, and
retaining existing subvolume snapshots</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume rm --vol_name<span class="o">=</span>string --sub_name<span class="o">=</span>string
  --group_name<span class="o">=</span>string --force --retain_snapshots
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
<li><p><strong>force</strong>: CephBool</p></li>
<li><p><strong>retain_snapshots</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-snapshot-clone">
<h2>fs subvolume snapshot clone<a class="headerlink" href="#fs-subvolume-snapshot-clone" title="Permalink to this headline">¶</a></h2>
<p>Clone a snapshot to target subvolume</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume snapshot clone --vol_name<span class="o">=</span>string --sub_name<span class="o">=</span>string
  --snap_name<span class="o">=</span>string --target_sub_name<span class="o">=</span>string --pool_layout<span class="o">=</span>string
  --group_name<span class="o">=</span>string --target_group_name<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>snap_name</strong>: (string)</p></li>
<li><p><strong>target_sub_name</strong>: (string)</p></li>
<li><p><strong>pool_layout</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
<li><p><strong>target_group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-snapshot-create">
<h2>fs subvolume snapshot create<a class="headerlink" href="#fs-subvolume-snapshot-create" title="Permalink to this headline">¶</a></h2>
<p>Create a snapshot of a CephFS subvolume in a volume, and optionally,
in a specific subvolume group</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume snapshot create --vol_name<span class="o">=</span>string --sub_name<span class="o">=</span>string
  --snap_name<span class="o">=</span>string --group_name<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>snap_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-snapshot-info">
<h2>fs subvolume snapshot info<a class="headerlink" href="#fs-subvolume-snapshot-info" title="Permalink to this headline">¶</a></h2>
<p>Get the metadata of a CephFS subvolume snapshot and optionally, in a
specific subvolume group</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume snapshot info --vol_name<span class="o">=</span>string --sub_name<span class="o">=</span>string
  --snap_name<span class="o">=</span>string --group_name<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>snap_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-snapshot-ls">
<h2>fs subvolume snapshot ls<a class="headerlink" href="#fs-subvolume-snapshot-ls" title="Permalink to this headline">¶</a></h2>
<p>List subvolume snapshots</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume snapshot ls my_vol_name my_sub_name my_group_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-snapshot-protect">
<h2>fs subvolume snapshot protect<a class="headerlink" href="#fs-subvolume-snapshot-protect" title="Permalink to this headline">¶</a></h2>
<p>(deprecated) Protect snapshot of a CephFS subvolume in a volume, and
optionally, in a specific subvolume group</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume snapshot protect --vol_name<span class="o">=</span>string --sub_name<span class="o">=</span>string
  --snap_name<span class="o">=</span>string --group_name<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>snap_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-snapshot-rm">
<h2>fs subvolume snapshot rm<a class="headerlink" href="#fs-subvolume-snapshot-rm" title="Permalink to this headline">¶</a></h2>
<p>Delete a snapshot of a CephFS subvolume in a volume, and optionally,
in a specific subvolume group</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume snapshot rm --vol_name<span class="o">=</span>string --sub_name<span class="o">=</span>string
  --snap_name<span class="o">=</span>string --group_name<span class="o">=</span>string --force
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>snap_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
<li><p><strong>force</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolume-snapshot-unprotect">
<h2>fs subvolume snapshot unprotect<a class="headerlink" href="#fs-subvolume-snapshot-unprotect" title="Permalink to this headline">¶</a></h2>
<p>(deprecated) Unprotect a snapshot of a CephFS subvolume in a volume,
and optionally, in a specific subvolume group</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolume snapshot unprotect --vol_name<span class="o">=</span>string
  --sub_name<span class="o">=</span>string --snap_name<span class="o">=</span>string --group_name<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>sub_name</strong>: (string)</p></li>
<li><p><strong>snap_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolumegroup-create">
<h2>fs subvolumegroup create<a class="headerlink" href="#fs-subvolumegroup-create" title="Permalink to this headline">¶</a></h2>
<p>Create a CephFS subvolume group in a volume, and optionally, with a
specific data pool layout, and a specific numeric mode</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolumegroup create --vol_name<span class="o">=</span>string --group_name<span class="o">=</span>string
  --pool_layout<span class="o">=</span>string --uid<span class="o">=</span><span class="m">1</span> --gid<span class="o">=</span><span class="m">1</span> --mode<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>pool_layout</strong>: (string)</p></li>
<li><p><strong>uid</strong>: CephInt</p></li>
<li><p><strong>gid</strong>: CephInt</p></li>
<li><p><strong>mode</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolumegroup-getpath">
<h2>fs subvolumegroup getpath<a class="headerlink" href="#fs-subvolumegroup-getpath" title="Permalink to this headline">¶</a></h2>
<p>Get the mountpath of a CephFS subvolume group in a volume</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolumegroup getpath my_vol_name my_group_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolumegroup-ls">
<h2>fs subvolumegroup ls<a class="headerlink" href="#fs-subvolumegroup-ls" title="Permalink to this headline">¶</a></h2>
<p>List subvolumegroups</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolumegroup ls my_vol_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolumegroup-pin">
<h2>fs subvolumegroup pin<a class="headerlink" href="#fs-subvolumegroup-pin" title="Permalink to this headline">¶</a></h2>
<p>Set MDS pinning policy for subvolumegroup</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolumegroup pin --vol_name<span class="o">=</span>string --group_name<span class="o">=</span>string
  --pin_type<span class="o">=</span><span class="nb">export</span> --pin_setting<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
<li><p><strong>pin_type</strong>: CephChoices  strings=(export distributed random)</p></li>
<li><p><strong>pin_setting</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolumegroup-rm">
<h2>fs subvolumegroup rm<a class="headerlink" href="#fs-subvolumegroup-rm" title="Permalink to this headline">¶</a></h2>
<p>Delete a CephFS subvolume group in a volume</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolumegroup rm my_vol_name my_group_name --force
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
<li><p><strong>force</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolumegroup-snapshot-create">
<h2>fs subvolumegroup snapshot create<a class="headerlink" href="#fs-subvolumegroup-snapshot-create" title="Permalink to this headline">¶</a></h2>
<p>Create a snapshot of a CephFS subvolume group in a volume</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolumegroup snapshot create my_vol_name my_group_name
  my_snap_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
<li><p><strong>snap_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolumegroup-snapshot-ls">
<h2>fs subvolumegroup snapshot ls<a class="headerlink" href="#fs-subvolumegroup-snapshot-ls" title="Permalink to this headline">¶</a></h2>
<p>List subvolumegroup snapshots</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolumegroup snapshot ls my_vol_name my_group_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-subvolumegroup-snapshot-rm">
<h2>fs subvolumegroup snapshot rm<a class="headerlink" href="#fs-subvolumegroup-snapshot-rm" title="Permalink to this headline">¶</a></h2>
<p>Delete a snapshot of a CephFS subvolume group in a volume</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs subvolumegroup snapshot rm --vol_name<span class="o">=</span>string
  --group_name<span class="o">=</span>string --snap_name<span class="o">=</span>string --force
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>group_name</strong>: (string)</p></li>
<li><p><strong>snap_name</strong>: (string)</p></li>
<li><p><strong>force</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-volume-create">
<h2>fs volume create<a class="headerlink" href="#fs-volume-create" title="Permalink to this headline">¶</a></h2>
<p>Create a CephFS volume</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs volume create my_name my_placement
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>placement</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-volume-ls">
<h2>fs volume ls<a class="headerlink" href="#fs-volume-ls" title="Permalink to this headline">¶</a></h2>
<p>List volumes</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs volume ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-volume-rename">
<h2>fs volume rename<a class="headerlink" href="#fs-volume-rename" title="Permalink to this headline">¶</a></h2>
<p>Rename a CephFS volume by passing –yes-i-really-mean-it flag</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs volume rename my_vol_name my_new_vol_name
  --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>new_vol_name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-volume-rm">
<h2>fs volume rm<a class="headerlink" href="#fs-volume-rm" title="Permalink to this headline">¶</a></h2>
<p>Delete a FS volume by passing –yes-i-really-mean-it flag</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs volume rm my_vol_name my_yes-i-really-mean-it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>vol_name</strong>: (string)</p></li>
<li><p><strong>yes-i-really-mean-it</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="influx">
<h1>influx<a class="headerlink" href="#influx" title="Permalink to this headline">¶</a></h1>
<div class="section" id="influx-config-set">
<h2>influx config-set<a class="headerlink" href="#influx-config-set" title="Permalink to this headline">¶</a></h2>
<p>Set a configuration value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph influx config-set my_key my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: (string)</p></li>
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="influx-config-show">
<h2>influx config-show<a class="headerlink" href="#influx-config-show" title="Permalink to this headline">¶</a></h2>
<p>Show current configuration</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph influx config-show
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="influx-send">
<h2>influx send<a class="headerlink" href="#influx-send" title="Permalink to this headline">¶</a></h2>
<p>Force sending data to Influx</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph influx send
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="k8sevents">
<h1>k8sevents<a class="headerlink" href="#k8sevents" title="Permalink to this headline">¶</a></h1>
<div class="section" id="k8sevents-ceph">
<h2>k8sevents ceph<a class="headerlink" href="#k8sevents-ceph" title="Permalink to this headline">¶</a></h2>
<p>List Ceph events tracked &amp; sent to the kubernetes cluster</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph k8sevents ceph
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="k8sevents-clear-config">
<h2>k8sevents clear-config<a class="headerlink" href="#k8sevents-clear-config" title="Permalink to this headline">¶</a></h2>
<p>Clear external kubernetes configuration settings</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph k8sevents clear-config
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="k8sevents-ls">
<h2>k8sevents ls<a class="headerlink" href="#k8sevents-ls" title="Permalink to this headline">¶</a></h2>
<p>List all current Kuberenetes events from the Ceph namespace</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph k8sevents ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="k8sevents-set-access">
<h2>k8sevents set-access<a class="headerlink" href="#k8sevents-set-access" title="Permalink to this headline">¶</a></h2>
<p>Set kubernetes access credentials. &lt;key&gt; must be cacrt or token and
use -i &lt;filename&gt; syntax (e.g., ceph k8sevents set-access cacrt -i
/root/ca.crt).</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph k8sevents set-access my_key
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="k8sevents-set-config">
<h2>k8sevents set-config<a class="headerlink" href="#k8sevents-set-config" title="Permalink to this headline">¶</a></h2>
<p>Set kubernetes config paramters. &lt;key&gt; must be server or namespace
(e.g., ceph k8sevents set-config server <a class="reference external" href="https://localhost:30433">https://localhost:30433</a>).</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph k8sevents set-config my_key my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: (string)</p></li>
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="k8sevents-status">
<h2>k8sevents status<a class="headerlink" href="#k8sevents-status" title="Permalink to this headline">¶</a></h2>
<p>Show the status of the data gathering threads</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph k8sevents status
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="orch">
<h1>orch<a class="headerlink" href="#orch" title="Permalink to this headline">¶</a></h1>
<div class="section" id="id1">
<h2>orch<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<p>Start, stop, restart, redeploy, or reconfig an entire service (i.e.
all daemons)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch start my_service_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>action</strong>: CephChoices  strings=(start stop restart redeploy reconfig)</p></li>
<li><p><strong>service_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-apply">
<h2>orch apply<a class="headerlink" href="#orch-apply" title="Permalink to this headline">¶</a></h2>
<p>Update the size or placement for a service or apply a large yaml spec</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch apply --service_type<span class="o">=</span>mon --placement<span class="o">=</span>string --dry_run
  --format<span class="o">=</span>plain --unmanaged --no_overwrite
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>service_type</strong>: CephChoices  strings=(mon mgr rbd-mirror cephfs-mirror crash alertmanager grafana node-exporter prometheus mds rgw nfs iscsi snmp-gateway)</p></li>
<li><p><strong>placement</strong>: (string)</p></li>
<li><p><strong>–dry_run</strong>: CephBool</p></li>
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
<li><p><strong>–unmanaged</strong>: CephBool</p></li>
<li><p><strong>–no_overwrite</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-apply-iscsi">
<h2>orch apply iscsi<a class="headerlink" href="#orch-apply-iscsi" title="Permalink to this headline">¶</a></h2>
<p>Scale an iSCSI service</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch apply iscsi --pool<span class="o">=</span>string --api_user<span class="o">=</span>string
  --api_password<span class="o">=</span>string --trusted_ip_list<span class="o">=</span>string --placement<span class="o">=</span>string
  --unmanaged --dry_run --format<span class="o">=</span>plain --no_overwrite
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: (string)</p></li>
<li><p><strong>api_user</strong>: (string)</p></li>
<li><p><strong>api_password</strong>: (string)</p></li>
<li><p><strong>trusted_ip_list</strong>: (string)</p></li>
<li><p><strong>placement</strong>: (string)</p></li>
<li><p><strong>–unmanaged</strong>: CephBool</p></li>
<li><p><strong>–dry_run</strong>: CephBool</p></li>
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
<li><p><strong>–no_overwrite</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-apply-mds">
<h2>orch apply mds<a class="headerlink" href="#orch-apply-mds" title="Permalink to this headline">¶</a></h2>
<p>Update the number of MDS instances for the given fs_name</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch apply mds --fs_name<span class="o">=</span>string --placement<span class="o">=</span>string --dry_run
  --unmanaged --format<span class="o">=</span>plain --no_overwrite
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
<li><p><strong>placement</strong>: (string)</p></li>
<li><p><strong>–dry_run</strong>: CephBool</p></li>
<li><p><strong>–unmanaged</strong>: CephBool</p></li>
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
<li><p><strong>–no_overwrite</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-apply-nfs">
<h2>orch apply nfs<a class="headerlink" href="#orch-apply-nfs" title="Permalink to this headline">¶</a></h2>
<p>Scale an NFS service</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch apply nfs --svc_id<span class="o">=</span>string --placement<span class="o">=</span>string --format<span class="o">=</span>plain
  --port<span class="o">=</span><span class="m">1</span> --dry_run --unmanaged --no_overwrite
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>svc_id</strong>: (string)</p></li>
<li><p><strong>placement</strong>: (string)</p></li>
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
<li><p><strong>–port</strong>: CephInt</p></li>
<li><p><strong>–dry_run</strong>: CephBool</p></li>
<li><p><strong>–unmanaged</strong>: CephBool</p></li>
<li><p><strong>–no_overwrite</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-apply-osd">
<h2>orch apply osd<a class="headerlink" href="#orch-apply-osd" title="Permalink to this headline">¶</a></h2>
<p>Create OSD daemon(s) on all available devices</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch apply osd --all_available_devices --format<span class="o">=</span>plain --unmanaged
  --dry_run --no_overwrite
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>–all_available_devices</strong>: CephBool</p></li>
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
<li><p><strong>–unmanaged</strong>: CephBool</p></li>
<li><p><strong>–dry_run</strong>: CephBool</p></li>
<li><p><strong>–no_overwrite</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-apply-rgw">
<h2>orch apply rgw<a class="headerlink" href="#orch-apply-rgw" title="Permalink to this headline">¶</a></h2>
<p>Update the number of RGW instances for the given zone</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch apply rgw --svc_id<span class="o">=</span>string --placement<span class="o">=</span>string --realm<span class="o">=</span>string
  --zone<span class="o">=</span>string --port<span class="o">=</span><span class="m">1</span> --ssl --dry_run --format<span class="o">=</span>plain --unmanaged
  --no_overwrite
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>svc_id</strong>: (string)</p></li>
<li><p><strong>placement</strong>: (string)</p></li>
<li><p><strong>–realm</strong>: (string)</p></li>
<li><p><strong>–zone</strong>: (string)</p></li>
<li><p><strong>–port</strong>: CephInt</p></li>
<li><p><strong>–ssl</strong>: CephBool</p></li>
<li><p><strong>–dry_run</strong>: CephBool</p></li>
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
<li><p><strong>–unmanaged</strong>: CephBool</p></li>
<li><p><strong>–no_overwrite</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-apply-snmp-gateway">
<h2>orch apply snmp-gateway<a class="headerlink" href="#orch-apply-snmp-gateway" title="Permalink to this headline">¶</a></h2>
<p>Add a Prometheus to SNMP gateway service (cephadm only)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch apply snmp-gateway --snmp_version<span class="o">=</span>V2c --destination<span class="o">=</span>string
  --port<span class="o">=</span><span class="m">1</span> --engine_id<span class="o">=</span>string --auth_protocol<span class="o">=</span>MD5 --privacy_protocol<span class="o">=</span>DES
  --placement<span class="o">=</span>string --unmanaged --dry_run --format<span class="o">=</span>plain --no_overwrite
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>snmp_version</strong>: CephChoices  strings=(V2c V3)</p></li>
<li><p><strong>destination</strong>: (string)</p></li>
<li><p><strong>port</strong>: CephInt</p></li>
<li><p><strong>engine_id</strong>: (string)</p></li>
<li><p><strong>auth_protocol</strong>: CephChoices  strings=(MD5 SHA)</p></li>
<li><p><strong>privacy_protocol</strong>: CephChoices  strings=(DES AES)</p></li>
<li><p><strong>placement</strong>: (string)</p></li>
<li><p><strong>–unmanaged</strong>: CephBool</p></li>
<li><p><strong>–dry_run</strong>: CephBool</p></li>
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
<li><p><strong>–no_overwrite</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-cancel">
<h2>orch cancel<a class="headerlink" href="#orch-cancel" title="Permalink to this headline">¶</a></h2>
<p>Cancel ongoing background operations</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch cancel
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-client-keyring-ls">
<h2>orch client-keyring ls<a class="headerlink" href="#orch-client-keyring-ls" title="Permalink to this headline">¶</a></h2>
<p>List client keyrings under cephadm management</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch client-keyring ls plain
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-client-keyring-rm">
<h2>orch client-keyring rm<a class="headerlink" href="#orch-client-keyring-rm" title="Permalink to this headline">¶</a></h2>
<p>Remove client keyring from cephadm management</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch client-keyring rm my_entity
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-client-keyring-set">
<h2>orch client-keyring set<a class="headerlink" href="#orch-client-keyring-set" title="Permalink to this headline">¶</a></h2>
<p>Add or update client keyring under cephadm management</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch client-keyring <span class="nb">set</span> --entity<span class="o">=</span>string --placement<span class="o">=</span>string
  --owner<span class="o">=</span>string --mode<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
<li><p><strong>placement</strong>: (string)</p></li>
<li><p><strong>owner</strong>: (string)</p></li>
<li><p><strong>mode</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-daemon">
<h2>orch daemon<a class="headerlink" href="#orch-daemon" title="Permalink to this headline">¶</a></h2>
<p>Start, stop, restart, (redeploy,) or reconfig a specific daemon</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch daemon start my_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>action</strong>: CephChoices  strings=(start stop restart reconfig)</p></li>
<li><p><strong>name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-daemon-add">
<h2>orch daemon add<a class="headerlink" href="#orch-daemon-add" title="Permalink to this headline">¶</a></h2>
<p>Add daemon(s)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch daemon add mon my_placement
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>daemon_type</strong>: CephChoices  strings=(mon mgr rbd-mirror cephfs-mirror crash alertmanager grafana node-exporter prometheus mds rgw nfs iscsi snmp-gateway)</p></li>
<li><p><strong>placement</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-daemon-add-iscsi">
<h2>orch daemon add iscsi<a class="headerlink" href="#orch-daemon-add-iscsi" title="Permalink to this headline">¶</a></h2>
<p>Start iscsi daemon(s)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch daemon add iscsi --pool<span class="o">=</span>string --api_user<span class="o">=</span>string
  --api_password<span class="o">=</span>string --trusted_ip_list<span class="o">=</span>string --placement<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: (string)</p></li>
<li><p><strong>api_user</strong>: (string)</p></li>
<li><p><strong>api_password</strong>: (string)</p></li>
<li><p><strong>trusted_ip_list</strong>: (string)</p></li>
<li><p><strong>placement</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-daemon-add-mds">
<h2>orch daemon add mds<a class="headerlink" href="#orch-daemon-add-mds" title="Permalink to this headline">¶</a></h2>
<p>Start MDS daemon(s)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch daemon add mds my_fs_name my_placement
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
<li><p><strong>placement</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-daemon-add-nfs">
<h2>orch daemon add nfs<a class="headerlink" href="#orch-daemon-add-nfs" title="Permalink to this headline">¶</a></h2>
<p>Start NFS daemon(s)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch daemon add nfs my_svc_id my_placement
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>svc_id</strong>: (string)</p></li>
<li><p><strong>placement</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-daemon-add-osd">
<h2>orch daemon add osd<a class="headerlink" href="#orch-daemon-add-osd" title="Permalink to this headline">¶</a></h2>
<p>Create OSD daemon(s) on specified host and device(s) (e.g., ceph orch
daemon add osd myhost:/dev/sdb)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch daemon add osd my_svc_arg raw
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>svc_arg</strong>: (string)</p></li>
<li><p><strong>method</strong>: CephChoices  strings=(raw lvm)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-daemon-add-rgw">
<h2>orch daemon add rgw<a class="headerlink" href="#orch-daemon-add-rgw" title="Permalink to this headline">¶</a></h2>
<p>Start RGW daemon(s)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch daemon add rgw --svc_id<span class="o">=</span>string --placement<span class="o">=</span>string --port<span class="o">=</span><span class="m">1</span>
  --ssl
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>svc_id</strong>: (string)</p></li>
<li><p><strong>placement</strong>: (string)</p></li>
<li><p><strong>–port</strong>: CephInt</p></li>
<li><p><strong>–ssl</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-daemon-redeploy">
<h2>orch daemon redeploy<a class="headerlink" href="#orch-daemon-redeploy" title="Permalink to this headline">¶</a></h2>
<p>Redeploy a daemon (with a specifc image)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch daemon redeploy my_name my_image
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
<li><p><strong>image</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-daemon-rm">
<h2>orch daemon rm<a class="headerlink" href="#orch-daemon-rm" title="Permalink to this headline">¶</a></h2>
<p>Remove specific daemon(s)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch daemon rm --names<span class="o">=</span>string --force
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>names</strong>: (can be repeated)</p></li>
<li><p><strong>–force</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-device-ls">
<h2>orch device ls<a class="headerlink" href="#orch-device-ls" title="Permalink to this headline">¶</a></h2>
<p>List devices on a host</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch device ls --hostname<span class="o">=</span>string --format<span class="o">=</span>plain --refresh --wide
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>hostname</strong>: (can be repeated)</p></li>
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
<li><p><strong>–refresh</strong>: CephBool</p></li>
<li><p><strong>–wide</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-device-zap">
<h2>orch device zap<a class="headerlink" href="#orch-device-zap" title="Permalink to this headline">¶</a></h2>
<p>Zap (erase!) a device so it can be re-used</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch device zap my_hostname my_path --force
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>hostname</strong>: (string)</p></li>
<li><p><strong>path</strong>: (string)</p></li>
<li><p><strong>–force</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-host-add">
<h2>orch host add<a class="headerlink" href="#orch-host-add" title="Permalink to this headline">¶</a></h2>
<p>Add a host</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch host add --hostname<span class="o">=</span>string --addr<span class="o">=</span>string --labels<span class="o">=</span>string
  --maintenance
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>hostname</strong>: (string)</p></li>
<li><p><strong>addr</strong>: (string)</p></li>
<li><p><strong>labels</strong>: (can be repeated)</p></li>
<li><p><strong>–maintenance</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-host-drain">
<h2>orch host drain<a class="headerlink" href="#orch-host-drain" title="Permalink to this headline">¶</a></h2>
<p>drain all daemons from a host</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch host drain my_hostname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>hostname</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-host-label-add">
<h2>orch host label add<a class="headerlink" href="#orch-host-label-add" title="Permalink to this headline">¶</a></h2>
<p>Add a host label</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch host label add my_hostname my_label
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>hostname</strong>: (string)</p></li>
<li><p><strong>label</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-host-label-rm">
<h2>orch host label rm<a class="headerlink" href="#orch-host-label-rm" title="Permalink to this headline">¶</a></h2>
<p>Remove a host label</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch host label rm my_hostname my_label
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>hostname</strong>: (string)</p></li>
<li><p><strong>label</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-host-ls">
<h2>orch host ls<a class="headerlink" href="#orch-host-ls" title="Permalink to this headline">¶</a></h2>
<p>List hosts</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch host ls --format<span class="o">=</span>plain --host_pattern<span class="o">=</span>string --label<span class="o">=</span>string
  --host_status<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
<li><p><strong>–host_pattern</strong>: (string)</p></li>
<li><p><strong>–label</strong>: (string)</p></li>
<li><p><strong>–host_status</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-host-maintenance-enter">
<h2>orch host maintenance enter<a class="headerlink" href="#orch-host-maintenance-enter" title="Permalink to this headline">¶</a></h2>
<p>Prepare a host for maintenance by shutting down and disabling all Ceph
daemons (cephadm only)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch host maintenance enter my_hostname --force
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>hostname</strong>: (string)</p></li>
<li><p><strong>–force</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-host-maintenance-exit">
<h2>orch host maintenance exit<a class="headerlink" href="#orch-host-maintenance-exit" title="Permalink to this headline">¶</a></h2>
<p>Return a host from maintenance, restarting all Ceph daemons (cephadm
only)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch host maintenance <span class="nb">exit</span> my_hostname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>hostname</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-host-ok-to-stop">
<h2>orch host ok-to-stop<a class="headerlink" href="#orch-host-ok-to-stop" title="Permalink to this headline">¶</a></h2>
<p>Check if the specified host can be safely stopped without reducing
availability</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch host ok-to-stop my_hostname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>hostname</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-host-rm">
<h2>orch host rm<a class="headerlink" href="#orch-host-rm" title="Permalink to this headline">¶</a></h2>
<p>Remove a host</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch host rm my_hostname --force --offline
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>hostname</strong>: (string)</p></li>
<li><p><strong>–force</strong>: CephBool</p></li>
<li><p><strong>–offline</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-host-set-addr">
<h2>orch host set-addr<a class="headerlink" href="#orch-host-set-addr" title="Permalink to this headline">¶</a></h2>
<p>Update a host address</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch host set-addr my_hostname my_addr
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>hostname</strong>: (string)</p></li>
<li><p><strong>addr</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-ls">
<h2>orch ls<a class="headerlink" href="#orch-ls" title="Permalink to this headline">¶</a></h2>
<p>List services known to orchestrator</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch ls --service_type<span class="o">=</span>string --service_name<span class="o">=</span>string --export
  --format<span class="o">=</span>plain --refresh
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>service_type</strong>: (string)</p></li>
<li><p><strong>service_name</strong>: (string)</p></li>
<li><p><strong>–export</strong>: CephBool</p></li>
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
<li><p><strong>–refresh</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-osd-rm">
<h2>orch osd rm<a class="headerlink" href="#orch-osd-rm" title="Permalink to this headline">¶</a></h2>
<p>Remove OSD daemons</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch osd rm --osd_id<span class="o">=</span>string --replace --force --zap
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>osd_id</strong>: (can be repeated)</p></li>
<li><p><strong>–replace</strong>: CephBool</p></li>
<li><p><strong>–force</strong>: CephBool</p></li>
<li><p><strong>–zap</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-osd-rm-status">
<h2>orch osd rm status<a class="headerlink" href="#orch-osd-rm-status" title="Permalink to this headline">¶</a></h2>
<p>Status of OSD removal operation</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch osd rm status plain
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-osd-rm-stop">
<h2>orch osd rm stop<a class="headerlink" href="#orch-osd-rm-stop" title="Permalink to this headline">¶</a></h2>
<p>Cancel ongoing OSD removal operation</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch osd rm stop --osd_id<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>osd_id</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-pause">
<h2>orch pause<a class="headerlink" href="#orch-pause" title="Permalink to this headline">¶</a></h2>
<p>Pause orchestrator background work</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch pause
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-ps">
<h2>orch ps<a class="headerlink" href="#orch-ps" title="Permalink to this headline">¶</a></h2>
<p>List daemons known to orchestrator</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch ps --hostname<span class="o">=</span>string --service_name<span class="o">=</span>string
  --daemon_type<span class="o">=</span>string --daemon_id<span class="o">=</span>string --format<span class="o">=</span>plain --refresh
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>hostname</strong>: (string)</p></li>
<li><p><strong>–service_name</strong>: (string)</p></li>
<li><p><strong>–daemon_type</strong>: (string)</p></li>
<li><p><strong>–daemon_id</strong>: (string)</p></li>
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
<li><p><strong>–refresh</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-resume">
<h2>orch resume<a class="headerlink" href="#orch-resume" title="Permalink to this headline">¶</a></h2>
<p>Resume orchestrator background work (if paused)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch resume
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-rm">
<h2>orch rm<a class="headerlink" href="#orch-rm" title="Permalink to this headline">¶</a></h2>
<p>Remove a service</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch rm my_service_name --force
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>service_name</strong>: (string)</p></li>
<li><p><strong>–force</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-set-backend">
<h2>orch set backend<a class="headerlink" href="#orch-set-backend" title="Permalink to this headline">¶</a></h2>
<p>Select orchestrator module backend</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch <span class="nb">set</span> backend my_module_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>module_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-status">
<h2>orch status<a class="headerlink" href="#orch-status" title="Permalink to this headline">¶</a></h2>
<p>Report configured backend and its status</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch status --detail plain
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>–detail</strong>: CephBool</p></li>
<li><p><strong>–format</strong>: CephChoices  strings=(plain json json-pretty yaml)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-upgrade-check">
<h2>orch upgrade check<a class="headerlink" href="#orch-upgrade-check" title="Permalink to this headline">¶</a></h2>
<p>Check service versions vs available and target containers</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch upgrade check my_image my_ceph_version
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>image</strong>: (string)</p></li>
<li><p><strong>ceph_version</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-upgrade-ls">
<h2>orch upgrade ls<a class="headerlink" href="#orch-upgrade-ls" title="Permalink to this headline">¶</a></h2>
<p>Check for available versions (or tags) we can upgrade to</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch upgrade ls my_image --tags
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>image</strong>: (string)</p></li>
<li><p><strong>–tags</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-upgrade-pause">
<h2>orch upgrade pause<a class="headerlink" href="#orch-upgrade-pause" title="Permalink to this headline">¶</a></h2>
<p>Pause an in-progress upgrade</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch upgrade pause
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-upgrade-resume">
<h2>orch upgrade resume<a class="headerlink" href="#orch-upgrade-resume" title="Permalink to this headline">¶</a></h2>
<p>Resume paused upgrade</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch upgrade resume
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-upgrade-start">
<h2>orch upgrade start<a class="headerlink" href="#orch-upgrade-start" title="Permalink to this headline">¶</a></h2>
<p>Initiate upgrade</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch upgrade start my_image my_ceph_version
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>image</strong>: (string)</p></li>
<li><p><strong>–ceph_version</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-upgrade-status">
<h2>orch upgrade status<a class="headerlink" href="#orch-upgrade-status" title="Permalink to this headline">¶</a></h2>
<p>Check service versions vs available and target containers</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch upgrade status
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="orch-upgrade-stop">
<h2>orch upgrade stop<a class="headerlink" href="#orch-upgrade-stop" title="Permalink to this headline">¶</a></h2>
<p>Stop an in-progress upgrade</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph orch upgrade stop
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="osd">
<h1>osd<a class="headerlink" href="#osd" title="Permalink to this headline">¶</a></h1>
<div class="section" id="osd-perf-counters-get">
<h2>osd perf counters get<a class="headerlink" href="#osd-perf-counters-get" title="Permalink to this headline">¶</a></h2>
<p>fetch osd perf counters</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd perf counters get <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>query_id</strong>: CephInt</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-perf-query-add">
<h2>osd perf query add<a class="headerlink" href="#osd-perf-query-add" title="Permalink to this headline">¶</a></h2>
<p>add osd perf query</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd perf query add client_id
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>query</strong>: CephChoices  strings=(client_id rbd_image_id all_subkeys)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-perf-query-remove">
<h2>osd perf query remove<a class="headerlink" href="#osd-perf-query-remove" title="Permalink to this headline">¶</a></h2>
<p>remove osd perf query</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd perf query remove <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>query_id</strong>: CephInt</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="progress">
<h1>progress<a class="headerlink" href="#progress" title="Permalink to this headline">¶</a></h1>
<div class="section" id="id2">
<h2>progress<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
<p>Show progress of recovery operations</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph progress
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="progress-clear">
<h2>progress clear<a class="headerlink" href="#progress-clear" title="Permalink to this headline">¶</a></h2>
<p>Reset progress tracking</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph progress clear
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="progress-json">
<h2>progress json<a class="headerlink" href="#progress-json" title="Permalink to this headline">¶</a></h2>
<p>Show machine readable progress information</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph progress json
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="progress-off">
<h2>progress off<a class="headerlink" href="#progress-off" title="Permalink to this headline">¶</a></h2>
<p>Disable progress tracking</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph progress off
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="progress-on">
<h2>progress on<a class="headerlink" href="#progress-on" title="Permalink to this headline">¶</a></h2>
<p>Enable progress tracking</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph progress on
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="restful">
<h1>restful<a class="headerlink" href="#restful" title="Permalink to this headline">¶</a></h1>
<div class="section" id="restful-create-key">
<h2>restful create-key<a class="headerlink" href="#restful-create-key" title="Permalink to this headline">¶</a></h2>
<p>Create an API key with this name</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph restful create-key my_key_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="restful-create-self-signed-cert">
<h2>restful create-self-signed-cert<a class="headerlink" href="#restful-create-self-signed-cert" title="Permalink to this headline">¶</a></h2>
<p>Create localized self signed certificate</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph restful create-self-signed-cert
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="restful-delete-key">
<h2>restful delete-key<a class="headerlink" href="#restful-delete-key" title="Permalink to this headline">¶</a></h2>
<p>Delete an API key with this name</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph restful delete-key my_key_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="restful-list-keys">
<h2>restful list-keys<a class="headerlink" href="#restful-list-keys" title="Permalink to this headline">¶</a></h2>
<p>List all API keys</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph restful list-keys
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="restful-restart">
<h2>restful restart<a class="headerlink" href="#restful-restart" title="Permalink to this headline">¶</a></h2>
<p>Restart API server</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph restful restart
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">mgr</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="add-bootstrap-peer-hint">
<h1>add_bootstrap_peer_hint<a class="headerlink" href="#add-bootstrap-peer-hint" title="Permalink to this headline">¶</a></h1>
<p>add peer address as potential bootstrap peer for cluster bringup</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph add_bootstrap_peer_hint <span class="m">0</span>.0.0.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>addr</strong>: CephIPAddr</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="add-bootstrap-peer-hintv">
<h1>add_bootstrap_peer_hintv<a class="headerlink" href="#add-bootstrap-peer-hintv" title="Permalink to this headline">¶</a></h1>
<p>add peer address vector as potential bootstrap peer for cluster
bringup</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph add_bootstrap_peer_hintv my_addrv
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>addrv</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth">
<h1>auth<a class="headerlink" href="#auth" title="Permalink to this headline">¶</a></h1>
<div class="section" id="auth-add">
<h2>auth add<a class="headerlink" href="#auth-add" title="Permalink to this headline">¶</a></h2>
<p>add auth info for &lt;entity&gt; from input file, or random key if no input
is given, and/or any caps specified in the command</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth add --entity<span class="o">=</span>string --caps<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
<li><p><strong>caps</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>auth</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rwx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth-caps">
<h2>auth caps<a class="headerlink" href="#auth-caps" title="Permalink to this headline">¶</a></h2>
<p>update caps for &lt;name&gt; from caps specified in the command</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth caps --entity<span class="o">=</span>string --caps<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
<li><p><strong>caps</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>auth</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rwx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth-del">
<h2>auth del<a class="headerlink" href="#auth-del" title="Permalink to this headline">¶</a></h2>
<p>delete all caps for &lt;name&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth del my_entity
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>auth</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rwx</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth-export">
<h2>auth export<a class="headerlink" href="#auth-export" title="Permalink to this headline">¶</a></h2>
<p>write keyring for requested entity, or master keyring if none given</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth <span class="nb">export</span> my_entity
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>auth</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth-get">
<h2>auth get<a class="headerlink" href="#auth-get" title="Permalink to this headline">¶</a></h2>
<p>write keyring file with requested key</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth get my_entity
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>auth</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth-get-key">
<h2>auth get-key<a class="headerlink" href="#auth-get-key" title="Permalink to this headline">¶</a></h2>
<p>display requested key</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth get-key my_entity
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>auth</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth-get-or-create">
<h2>auth get-or-create<a class="headerlink" href="#auth-get-or-create" title="Permalink to this headline">¶</a></h2>
<p>add auth info for &lt;entity&gt; from input file, or random key if no input
given, and/or any caps specified in the command</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth get-or-create --entity<span class="o">=</span>string --caps<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
<li><p><strong>caps</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>auth</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rwx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth-get-or-create-key">
<h2>auth get-or-create-key<a class="headerlink" href="#auth-get-or-create-key" title="Permalink to this headline">¶</a></h2>
<p>get, or add, key for &lt;name&gt; from system/caps pairs specified in the
command.  If key already exists, any given caps must match the
existing caps for that key.</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth get-or-create-key --entity<span class="o">=</span>string --caps<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
<li><p><strong>caps</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>auth</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rwx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth-import">
<h2>auth import<a class="headerlink" href="#auth-import" title="Permalink to this headline">¶</a></h2>
<p>auth import: read keyring file from -i &lt;file&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth import
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>auth</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rwx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth-list">
<h2>auth list<a class="headerlink" href="#auth-list" title="Permalink to this headline">¶</a></h2>
<p>list authentication state</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth list
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>auth</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rx</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth-ls">
<h2>auth ls<a class="headerlink" href="#auth-ls" title="Permalink to this headline">¶</a></h2>
<p>list authentication state</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>auth</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth-print-key">
<h2>auth print-key<a class="headerlink" href="#auth-print-key" title="Permalink to this headline">¶</a></h2>
<p>display requested key</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth print-key my_entity
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>auth</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="id3">
<h2>auth print_key<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
<p>display requested key</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth print_key my_entity
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>auth</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="auth-rm">
<h2>auth rm<a class="headerlink" href="#auth-rm" title="Permalink to this headline">¶</a></h2>
<p>remove all caps for &lt;name&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph auth rm my_entity
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>entity</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>auth</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rwx</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="compact">
<h1>compact<a class="headerlink" href="#compact" title="Permalink to this headline">¶</a></h1>
<p>cause compaction of monitor’s leveldb/rocksdb storage</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph compact
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config">
<h1>config<a class="headerlink" href="#config" title="Permalink to this headline">¶</a></h1>
<div class="section" id="config-assimilate-conf">
<h2>config assimilate-conf<a class="headerlink" href="#config-assimilate-conf" title="Permalink to this headline">¶</a></h2>
<p>Assimilate options from a conf, and return a new, minimal conf file</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config assimilate-conf
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>config</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-dump">
<h2>config dump<a class="headerlink" href="#config-dump" title="Permalink to this headline">¶</a></h2>
<p>Show all configuration option(s)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config dump
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-generate-minimal-conf">
<h2>config generate-minimal-conf<a class="headerlink" href="#config-generate-minimal-conf" title="Permalink to this headline">¶</a></h2>
<p>Generate a minimal ceph.conf file</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config generate-minimal-conf
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>config</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-get">
<h2>config get<a class="headerlink" href="#config-get" title="Permalink to this headline">¶</a></h2>
<p>Show configuration option(s) for an entity</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config get string my_key
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: (string)</p></li>
<li><p><strong>key</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-help">
<h2>config help<a class="headerlink" href="#config-help" title="Permalink to this headline">¶</a></h2>
<p>Describe a configuration option</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config <span class="nb">help</span> my_key
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-log">
<h2>config log<a class="headerlink" href="#config-log" title="Permalink to this headline">¶</a></h2>
<p>Show recent history of config changes</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config log <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>num</strong>: CephInt</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-ls">
<h2>config ls<a class="headerlink" href="#config-ls" title="Permalink to this headline">¶</a></h2>
<p>List available configuration options</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>config</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-reset">
<h2>config reset<a class="headerlink" href="#config-reset" title="Permalink to this headline">¶</a></h2>
<p>Revert configuration to a historical version specified by &lt;num&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config reset <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>num</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-rm">
<h2>config rm<a class="headerlink" href="#config-rm" title="Permalink to this headline">¶</a></h2>
<p>Clear a configuration option for one or more entities</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config rm string my_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: (string)</p></li>
<li><p><strong>name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-set">
<h2>config set<a class="headerlink" href="#config-set" title="Permalink to this headline">¶</a></h2>
<p>Set a configuration option for one or more entities</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config <span class="nb">set</span> --who<span class="o">=</span>string --name<span class="o">=</span>string --value<span class="o">=</span>string --force
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: (string)</p></li>
<li><p><strong>name</strong>: (string)</p></li>
<li><p><strong>value</strong>: (string)</p></li>
<li><p><strong>force</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-show">
<h2>config show<a class="headerlink" href="#config-show" title="Permalink to this headline">¶</a></h2>
<p>Show running configuration</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config show string my_key
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: (string)</p></li>
<li><p><strong>key</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-show-with-defaults">
<h2>config show-with-defaults<a class="headerlink" href="#config-show-with-defaults" title="Permalink to this headline">¶</a></h2>
<p>Show running configuration (including compiled-in defaults)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config show-with-defaults string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="config-key">
<h1>config-key<a class="headerlink" href="#config-key" title="Permalink to this headline">¶</a></h1>
<div class="section" id="config-key-del">
<h2>config-key del<a class="headerlink" href="#config-key-del" title="Permalink to this headline">¶</a></h2>
<p>delete &lt;key&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config-key del my_key
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config-key</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-key-dump">
<h2>config-key dump<a class="headerlink" href="#config-key-dump" title="Permalink to this headline">¶</a></h2>
<p>dump keys and values (with optional prefix)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config-key dump my_key
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config-key</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-key-exists">
<h2>config-key exists<a class="headerlink" href="#config-key-exists" title="Permalink to this headline">¶</a></h2>
<p>check for &lt;key&gt;’s existence</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config-key exists my_key
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config-key</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-key-get">
<h2>config-key get<a class="headerlink" href="#config-key-get" title="Permalink to this headline">¶</a></h2>
<p>get &lt;key&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config-key get my_key
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config-key</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-key-list">
<h2>config-key list<a class="headerlink" href="#config-key-list" title="Permalink to this headline">¶</a></h2>
<p>list keys</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config-key list
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>config-key</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-key-ls">
<h2>config-key ls<a class="headerlink" href="#config-key-ls" title="Permalink to this headline">¶</a></h2>
<p>list keys</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config-key ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>config-key</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-key-put">
<h2>config-key put<a class="headerlink" href="#config-key-put" title="Permalink to this headline">¶</a></h2>
<p>put &lt;key&gt;, value &lt;val&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config-key put my_key my_val
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: (string)</p></li>
<li><p><strong>val</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config-key</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-key-rm">
<h2>config-key rm<a class="headerlink" href="#config-key-rm" title="Permalink to this headline">¶</a></h2>
<p>rm &lt;key&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config-key rm my_key
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config-key</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="config-key-set">
<h2>config-key set<a class="headerlink" href="#config-key-set" title="Permalink to this headline">¶</a></h2>
<p>set &lt;key&gt; to value &lt;val&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph config-key <span class="nb">set</span> my_key my_val
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: (string)</p></li>
<li><p><strong>val</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>config-key</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="connection">
<h1>connection<a class="headerlink" href="#connection" title="Permalink to this headline">¶</a></h1>
<div class="section" id="connection-scores-dump">
<h2>connection scores dump<a class="headerlink" href="#connection-scores-dump" title="Permalink to this headline">¶</a></h2>
<p>show the scores used in connectivity-based elections</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph connection scores dump
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rwx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="connection-scores-reset">
<h2>connection scores reset<a class="headerlink" href="#connection-scores-reset" title="Permalink to this headline">¶</a></h2>
<p>reset the scores used in connectivity-based elections</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph connection scores reset
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rwx</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="id4">
<h1>device<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h1>
<div class="section" id="device-info">
<h2>device info<a class="headerlink" href="#device-info" title="Permalink to this headline">¶</a></h2>
<p>Show information about a device</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph device info my_devid
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>devid</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="device-ls">
<h2>device ls<a class="headerlink" href="#device-ls" title="Permalink to this headline">¶</a></h2>
<p>Show devices</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph device ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="device-ls-by-daemon">
<h2>device ls-by-daemon<a class="headerlink" href="#device-ls-by-daemon" title="Permalink to this headline">¶</a></h2>
<p>Show devices associated with a daemon</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph device ls-by-daemon string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="device-ls-by-host">
<h2>device ls-by-host<a class="headerlink" href="#device-ls-by-host" title="Permalink to this headline">¶</a></h2>
<p>Show devices on a host</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph device ls-by-host my_host
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>host</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="device-rm-life-expectancy">
<h2>device rm-life-expectancy<a class="headerlink" href="#device-rm-life-expectancy" title="Permalink to this headline">¶</a></h2>
<p>Clear predicted device life expectancy</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph device rm-life-expectancy my_devid
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>devid</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="device-set-life-expectancy">
<h2>device set-life-expectancy<a class="headerlink" href="#device-set-life-expectancy" title="Permalink to this headline">¶</a></h2>
<p>Set predicted device life expectancy</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph device set-life-expectancy my_devid my_from my_to
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>devid</strong>: (string)</p></li>
<li><p><strong>from</strong>: (string)</p></li>
<li><p><strong>to</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="df">
<h1>df<a class="headerlink" href="#df" title="Permalink to this headline">¶</a></h1>
<p>show cluster free space stats</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph df detail
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>detail</strong>: CephChoices  strings=(detail)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="dump-historic-ops">
<h1>dump_historic_ops<a class="headerlink" href="#dump-historic-ops" title="Permalink to this headline">¶</a></h1>
<p>dump_historic_ops</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph dump_historic_ops
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="features">
<h1>features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h1>
<p>report of connected features</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph features
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="id5">
<h1>fs<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h1>
<div class="section" id="fs-add-data-pool">
<h2>fs add_data_pool<a class="headerlink" href="#fs-add-data-pool" title="Permalink to this headline">¶</a></h2>
<p>add data pool &lt;pool&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs add_data_pool my_fs_name my_pool
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
<li><p><strong>pool</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-authorize">
<h2>fs authorize<a class="headerlink" href="#fs-authorize" title="Permalink to this headline">¶</a></h2>
<p>add auth for &lt;entity&gt; to access file system &lt;filesystem&gt; based on
following directory and permissions pairs</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs authorize --filesystem<span class="o">=</span>string --entity<span class="o">=</span>string --caps<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>filesystem</strong>: (string)</p></li>
<li><p><strong>entity</strong>: (string)</p></li>
<li><p><strong>caps</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>auth</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rwx</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-compat">
<h2>fs compat<a class="headerlink" href="#fs-compat" title="Permalink to this headline">¶</a></h2>
<p>manipulate compat settings</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs compat --fs_name<span class="o">=</span>string --subop<span class="o">=</span>rm_compat --feature<span class="o">=</span><span class="m">1</span>
  --feature_str<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
<li><p><strong>subop</strong>: CephChoices  strings=(rm_compat rm_incompat add_compat add_incompat)</p></li>
<li><p><strong>feature</strong>: CephInt</p></li>
<li><p><strong>feature_str</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>fs</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-compat-show">
<h2>fs compat show<a class="headerlink" href="#fs-compat-show" title="Permalink to this headline">¶</a></h2>
<p>show fs compatibility settings</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs compat show my_fs_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-dump">
<h2>fs dump<a class="headerlink" href="#fs-dump" title="Permalink to this headline">¶</a></h2>
<p>dump all CephFS status, optionally from epoch</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs dump <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>epoch</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-fail">
<h2>fs fail<a class="headerlink" href="#fs-fail" title="Permalink to this headline">¶</a></h2>
<p>bring the file system down and all of its ranks</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs fail my_fs_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>fs</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-feature-ls">
<h2>fs feature ls<a class="headerlink" href="#fs-feature-ls" title="Permalink to this headline">¶</a></h2>
<p>list available cephfs features to be set/unset</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs feature ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mds</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-flag-set">
<h2>fs flag set<a class="headerlink" href="#fs-flag-set" title="Permalink to this headline">¶</a></h2>
<p>Set a global CephFS flag</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs flag <span class="nb">set</span> enable_multiple my_val --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>flag_name</strong>: CephChoices  strings=(enable_multiple)</p></li>
<li><p><strong>val</strong>: (string)</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>fs</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-get">
<h2>fs get<a class="headerlink" href="#fs-get" title="Permalink to this headline">¶</a></h2>
<p>get info about one filesystem</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs get my_fs_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>fs</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-ls">
<h2>fs ls<a class="headerlink" href="#fs-ls" title="Permalink to this headline">¶</a></h2>
<p>list filesystems</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>fs</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-lsflags">
<h2>fs lsflags<a class="headerlink" href="#fs-lsflags" title="Permalink to this headline">¶</a></h2>
<p>list the flags set on a ceph filesystem</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs lsflags my_fs_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>fs</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-mirror-disable">
<h2>fs mirror disable<a class="headerlink" href="#fs-mirror-disable" title="Permalink to this headline">¶</a></h2>
<p>disable mirroring for a ceph filesystem</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs mirror disable my_fs_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-mirror-enable">
<h2>fs mirror enable<a class="headerlink" href="#fs-mirror-enable" title="Permalink to this headline">¶</a></h2>
<p>enable mirroring for a ceph filesystem</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs mirror <span class="nb">enable</span> my_fs_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-mirror-peer-add">
<h2>fs mirror peer_add<a class="headerlink" href="#fs-mirror-peer-add" title="Permalink to this headline">¶</a></h2>
<p>add a mirror peer for a ceph filesystem</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs mirror peer_add --fs_name<span class="o">=</span>string --uuid<span class="o">=</span>string
  --remote_cluster_spec<span class="o">=</span>string --remote_fs_name<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
<li><p><strong>uuid</strong>: (string)</p></li>
<li><p><strong>remote_cluster_spec</strong>: (string)</p></li>
<li><p><strong>remote_fs_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-mirror-peer-remove">
<h2>fs mirror peer_remove<a class="headerlink" href="#fs-mirror-peer-remove" title="Permalink to this headline">¶</a></h2>
<p>remove a mirror peer for a ceph filesystem</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs mirror peer_remove my_fs_name my_uuid
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
<li><p><strong>uuid</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-new">
<h2>fs new<a class="headerlink" href="#fs-new" title="Permalink to this headline">¶</a></h2>
<p>make new filesystem using named pools &lt;metadata&gt; and &lt;data&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs new --fs_name<span class="o">=</span>string --metadata<span class="o">=</span>string --data<span class="o">=</span>string --force
  --allow_dangerous_metadata_overlay --fscid<span class="o">=</span><span class="m">0</span> --recover
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>metadata</strong>: (string)</p></li>
<li><p><strong>data</strong>: (string)</p></li>
<li><p><strong>force</strong>: CephBool</p></li>
<li><p><strong>allow_dangerous_metadata_overlay</strong>: CephBool</p></li>
<li><p><strong>fscid</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
<li><p><strong>recover</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>fs</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-rename">
<h2>fs rename<a class="headerlink" href="#fs-rename" title="Permalink to this headline">¶</a></h2>
<p>rename a ceph file system</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs rename my_fs_name my_new_fs_name --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
<li><p><strong>new_fs_name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-required-client-features">
<h2>fs required_client_features<a class="headerlink" href="#fs-required-client-features" title="Permalink to this headline">¶</a></h2>
<p>add/remove required features of clients</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs required_client_features my_fs_name add my_val
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
<li><p><strong>subop</strong>: CephChoices  strings=(add rm)</p></li>
<li><p><strong>val</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-reset">
<h2>fs reset<a class="headerlink" href="#fs-reset" title="Permalink to this headline">¶</a></h2>
<p>disaster recovery only: reset to a single-MDS map</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs reset my_fs_name --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>fs</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-rm">
<h2>fs rm<a class="headerlink" href="#fs-rm" title="Permalink to this headline">¶</a></h2>
<p>disable the named filesystem</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs rm my_fs_name --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>fs</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-rm-data-pool">
<h2>fs rm_data_pool<a class="headerlink" href="#fs-rm-data-pool" title="Permalink to this headline">¶</a></h2>
<p>remove data pool &lt;pool&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs rm_data_pool my_fs_name my_pool
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
<li><p><strong>pool</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-set">
<h2>fs set<a class="headerlink" href="#fs-set" title="Permalink to this headline">¶</a></h2>
<p>set fs parameter &lt;var&gt; to &lt;val&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs <span class="nb">set</span> --fs_name<span class="o">=</span>string --var<span class="o">=</span>max_mds --val<span class="o">=</span>string
  --yes_i_really_mean_it --yes_i_really_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
<li><p><strong>var</strong>: CephChoices  strings=(max_mds max_file_size allow_new_snaps inline_data cluster_down allow_dirfrags balancer standby_count_wanted session_timeout session_autoclose allow_standby_replay down joinable min_compat_client)</p></li>
<li><p><strong>val</strong>: (string)</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
<li><p><strong>yes_i_really_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="fs-set-default">
<h2>fs set-default<a class="headerlink" href="#fs-set-default" title="Permalink to this headline">¶</a></h2>
<p>set the default to the named filesystem</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs set-default my_fs_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>fs</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="id6">
<h2>fs set_default<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
<p>set the default to the named filesystem</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fs set_default my_fs_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>fs_name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>fs</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="fsid">
<h1>fsid<a class="headerlink" href="#fsid" title="Permalink to this headline">¶</a></h1>
<p>show cluster FSID/UUID</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph fsid
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="health">
<h1>health<a class="headerlink" href="#health" title="Permalink to this headline">¶</a></h1>
<div class="section" id="id7">
<h2>health<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h2>
<p>show cluster health</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph health detail
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>detail</strong>: CephChoices  strings=(detail)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="health-mute">
<h2>health mute<a class="headerlink" href="#health-mute" title="Permalink to this headline">¶</a></h2>
<p>mute health alert</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph health mute my_code my_ttl --sticky
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>code</strong>: (string)</p></li>
<li><p><strong>ttl</strong>: (string)</p></li>
<li><p><strong>sticky</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="health-unmute">
<h2>health unmute<a class="headerlink" href="#health-unmute" title="Permalink to this headline">¶</a></h2>
<p>unmute existing health alert mute(s)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph health unmute my_code
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>code</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">w</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="heap">
<h1>heap<a class="headerlink" href="#heap" title="Permalink to this headline">¶</a></h1>
<p>show heap usage info (available only if compiled with tcmalloc)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph heap dump my_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>heapcmd</strong>: CephChoices  strings=(dump start_profiler stop_profiler release stats)</p></li>
<li><p><strong>value</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="injectargs">
<h1>injectargs<a class="headerlink" href="#injectargs" title="Permalink to this headline">¶</a></h1>
<p>inject config arguments into monitor</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph injectargs --injected_args<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>injected_args</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="log">
<h1>log<a class="headerlink" href="#log" title="Permalink to this headline">¶</a></h1>
<div class="section" id="id8">
<h2>log<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h2>
<p>log supplied text to the monitor log</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph log --logtext<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>logtext</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="log-last">
<h2>log last<a class="headerlink" href="#log-last" title="Permalink to this headline">¶</a></h2>
<p>print last few lines of the cluster log</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph log last <span class="m">1</span> debug *
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>num</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">1</span></code></p></li>
<li><p><strong>level</strong>: CephChoices  strings=(debug info sec warn error)</p></li>
<li><p><strong>channel</strong>: CephChoices  strings=(* cluster audit cephadm)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="mds">
<h1>mds<a class="headerlink" href="#mds" title="Permalink to this headline">¶</a></h1>
<div class="section" id="mds-compat-rm-compat">
<h2>mds compat rm_compat<a class="headerlink" href="#mds-compat-rm-compat" title="Permalink to this headline">¶</a></h2>
<p>remove compatible feature</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mds compat rm_compat <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>feature</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mds-compat-rm-incompat">
<h2>mds compat rm_incompat<a class="headerlink" href="#mds-compat-rm-incompat" title="Permalink to this headline">¶</a></h2>
<p>remove incompatible feature</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mds compat rm_incompat <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>feature</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mds-compat-show">
<h2>mds compat show<a class="headerlink" href="#mds-compat-show" title="Permalink to this headline">¶</a></h2>
<p>show mds compatibility settings</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mds compat show
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mds</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mds-count-metadata">
<h2>mds count-metadata<a class="headerlink" href="#mds-count-metadata" title="Permalink to this headline">¶</a></h2>
<p>count MDSs by metadata field property</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mds count-metadata my_property
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>property</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mds-fail">
<h2>mds fail<a class="headerlink" href="#mds-fail" title="Permalink to this headline">¶</a></h2>
<p>Mark MDS failed: trigger a failover if a standby is available</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mds fail my_role_or_gid
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>role_or_gid</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mds-metadata">
<h2>mds metadata<a class="headerlink" href="#mds-metadata" title="Permalink to this headline">¶</a></h2>
<p>fetch metadata for mds &lt;role&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mds metadata string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mds-ok-to-stop">
<h2>mds ok-to-stop<a class="headerlink" href="#mds-ok-to-stop" title="Permalink to this headline">¶</a></h2>
<p>check whether stopping the specified MDS would reduce immediate
availability</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mds ok-to-stop --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mds-repaired">
<h2>mds repaired<a class="headerlink" href="#mds-repaired" title="Permalink to this headline">¶</a></h2>
<p>mark a damaged MDS rank as no longer damaged</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mds repaired my_role
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>role</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mds-rm">
<h2>mds rm<a class="headerlink" href="#mds-rm" title="Permalink to this headline">¶</a></h2>
<p>remove nonactive mds</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mds rm <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>gid</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mds</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mds-versions">
<h2>mds versions<a class="headerlink" href="#mds-versions" title="Permalink to this headline">¶</a></h2>
<p>check running versions of MDSs</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mds versions
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mds</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="mgr">
<h1>mgr<a class="headerlink" href="#mgr" title="Permalink to this headline">¶</a></h1>
<div class="section" id="mgr-count-metadata">
<h2>mgr count-metadata<a class="headerlink" href="#mgr-count-metadata" title="Permalink to this headline">¶</a></h2>
<p>count ceph-mgr daemons by metadata field property</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mgr count-metadata my_property
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>property</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mgr-dump">
<h2>mgr dump<a class="headerlink" href="#mgr-dump" title="Permalink to this headline">¶</a></h2>
<p>dump the latest MgrMap</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mgr dump <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>epoch</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mgr-fail">
<h2>mgr fail<a class="headerlink" href="#mgr-fail" title="Permalink to this headline">¶</a></h2>
<p>treat the named manager daemon as failed</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mgr fail string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mgr-metadata">
<h2>mgr metadata<a class="headerlink" href="#mgr-metadata" title="Permalink to this headline">¶</a></h2>
<p>dump metadata for all daemons or a specific daemon</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mgr metadata string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mgr-module-disable">
<h2>mgr module disable<a class="headerlink" href="#mgr-module-disable" title="Permalink to this headline">¶</a></h2>
<p>disable mgr module</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mgr module disable my_module
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>module</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mgr-module-enable">
<h2>mgr module enable<a class="headerlink" href="#mgr-module-enable" title="Permalink to this headline">¶</a></h2>
<p>enable mgr module</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mgr module <span class="nb">enable</span> my_module --force
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>module</strong>: (string)</p></li>
<li><p><strong>force</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mgr</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mgr-module-ls">
<h2>mgr module ls<a class="headerlink" href="#mgr-module-ls" title="Permalink to this headline">¶</a></h2>
<p>list active mgr modules</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mgr module ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mgr-services">
<h2>mgr services<a class="headerlink" href="#mgr-services" title="Permalink to this headline">¶</a></h2>
<p>list service endpoints provided by mgr modules</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mgr services
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mgr-stat">
<h2>mgr stat<a class="headerlink" href="#mgr-stat" title="Permalink to this headline">¶</a></h2>
<p>dump basic info about the mgr cluster state</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mgr stat
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mgr-versions">
<h2>mgr versions<a class="headerlink" href="#mgr-versions" title="Permalink to this headline">¶</a></h2>
<p>check running versions of ceph-mgr daemons</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mgr versions
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mgr</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="mon">
<h1>mon<a class="headerlink" href="#mon" title="Permalink to this headline">¶</a></h1>
<div class="section" id="mon-add">
<h2>mon add<a class="headerlink" href="#mon-add" title="Permalink to this headline">¶</a></h2>
<p>add new monitor named &lt;name&gt; at &lt;addr&gt;, possibly with CRUSH location
&lt;location&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon add --name<span class="o">=</span>string --addr<span class="o">=</span><span class="m">0</span>.0.0.0 --location<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
<li><p><strong>addr</strong>: CephIPAddr</p></li>
<li><p><strong>location</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.=]</span></code>  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-add-disallowed-leader">
<h2>mon add disallowed_leader<a class="headerlink" href="#mon-add-disallowed-leader" title="Permalink to this headline">¶</a></h2>
<p>prevent the named mon from being a leader</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon add disallowed_leader my_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-count-metadata">
<h2>mon count-metadata<a class="headerlink" href="#mon-count-metadata" title="Permalink to this headline">¶</a></h2>
<p>count mons by metadata field property</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon count-metadata my_property
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>property</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-dump">
<h2>mon dump<a class="headerlink" href="#mon-dump" title="Permalink to this headline">¶</a></h2>
<p>dump formatted monmap (optionally from epoch)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon dump <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>epoch</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-enable-msgr2">
<h2>mon enable-msgr2<a class="headerlink" href="#mon-enable-msgr2" title="Permalink to this headline">¶</a></h2>
<p>enable the msgr2 protocol on port 3300</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon enable-msgr2
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-enable-stretch-mode">
<h2>mon enable_stretch_mode<a class="headerlink" href="#mon-enable-stretch-mode" title="Permalink to this headline">¶</a></h2>
<p>enable stretch mode, changing the peering rules and failure handling
on all pools with &lt;tiebreaker_mon&gt; as the tiebreaker and setting
&lt;dividing_bucket&gt; locations as the units for stretching across</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon enable_stretch_mode my_tiebreaker_mon my_new_crush_rule
  my_dividing_bucket
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>tiebreaker_mon</strong>: (string)</p></li>
<li><p><strong>new_crush_rule</strong>: (string)</p></li>
<li><p><strong>dividing_bucket</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-feature-ls">
<h2>mon feature ls<a class="headerlink" href="#mon-feature-ls" title="Permalink to this headline">¶</a></h2>
<p>list available mon map features to be set/unset</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon feature ls --with_value
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>with_value</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-feature-set">
<h2>mon feature set<a class="headerlink" href="#mon-feature-set" title="Permalink to this headline">¶</a></h2>
<p>set provided feature on mon map</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon feature <span class="nb">set</span> my_feature_name --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>feature_name</strong>: (string)</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-getmap">
<h2>mon getmap<a class="headerlink" href="#mon-getmap" title="Permalink to this headline">¶</a></h2>
<p>get monmap</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon getmap <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>epoch</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-metadata">
<h2>mon metadata<a class="headerlink" href="#mon-metadata" title="Permalink to this headline">¶</a></h2>
<p>fetch metadata for mon &lt;id&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon metadata my_id
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-ok-to-add-offline">
<h2>mon ok-to-add-offline<a class="headerlink" href="#mon-ok-to-add-offline" title="Permalink to this headline">¶</a></h2>
<p>check whether adding a mon and not starting it would break quorum</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon ok-to-add-offline
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-ok-to-rm">
<h2>mon ok-to-rm<a class="headerlink" href="#mon-ok-to-rm" title="Permalink to this headline">¶</a></h2>
<p>check whether removing the specified mon would break quorum</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon ok-to-rm my_id
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-ok-to-stop">
<h2>mon ok-to-stop<a class="headerlink" href="#mon-ok-to-stop" title="Permalink to this headline">¶</a></h2>
<p>check whether mon(s) can be safely stopped without reducing immediate
availability</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon ok-to-stop --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-remove">
<h2>mon remove<a class="headerlink" href="#mon-remove" title="Permalink to this headline">¶</a></h2>
<p>remove monitor named &lt;name&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon remove my_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-rm">
<h2>mon rm<a class="headerlink" href="#mon-rm" title="Permalink to this headline">¶</a></h2>
<p>remove monitor named &lt;name&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon rm my_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-rm-disallowed-leader">
<h2>mon rm disallowed_leader<a class="headerlink" href="#mon-rm-disallowed-leader" title="Permalink to this headline">¶</a></h2>
<p>allow the named mon to be a leader again</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon rm disallowed_leader my_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-scrub">
<h2>mon scrub<a class="headerlink" href="#mon-scrub" title="Permalink to this headline">¶</a></h2>
<p>scrub the monitor stores</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon scrub
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-set-election-strategy">
<h2>mon set election_strategy<a class="headerlink" href="#mon-set-election-strategy" title="Permalink to this headline">¶</a></h2>
<p>set the election strategy to use; choices classic, disallow,
connectivity</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon <span class="nb">set</span> election_strategy my_strategy
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>strategy</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-set-addrs">
<h2>mon set-addrs<a class="headerlink" href="#mon-set-addrs" title="Permalink to this headline">¶</a></h2>
<p>set the addrs (IPs and ports) a specific monitor binds to</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon set-addrs my_name my_addrs
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
<li><p><strong>addrs</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-set-rank">
<h2>mon set-rank<a class="headerlink" href="#mon-set-rank" title="Permalink to this headline">¶</a></h2>
<p>set the rank for the specified mon</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon set-rank my_name <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
<li><p><strong>rank</strong>: CephInt</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-set-weight">
<h2>mon set-weight<a class="headerlink" href="#mon-set-weight" title="Permalink to this headline">¶</a></h2>
<p>set the weight for the specified mon</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon set-weight my_name <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
<li><p><strong>weight</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0..65535</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-set-location">
<h2>mon set_location<a class="headerlink" href="#mon-set-location" title="Permalink to this headline">¶</a></h2>
<p>specify location &lt;args&gt; for the monitor &lt;name&gt;, using CRUSH bucket
names</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon set_location --name<span class="o">=</span>string --args<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
<li><p><strong>args</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.=]</span></code>  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-set-new-tiebreaker">
<h2>mon set_new_tiebreaker<a class="headerlink" href="#mon-set-new-tiebreaker" title="Permalink to this headline">¶</a></h2>
<p>switch the stretch tiebreaker to be the named mon</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon set_new_tiebreaker my_name --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-stat">
<h2>mon stat<a class="headerlink" href="#mon-stat" title="Permalink to this headline">¶</a></h2>
<p>summarize monitor status</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon stat
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="mon-versions">
<h2>mon versions<a class="headerlink" href="#mon-versions" title="Permalink to this headline">¶</a></h2>
<p>check running versions of monitors</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon versions
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="mon-status">
<h1>mon_status<a class="headerlink" href="#mon-status" title="Permalink to this headline">¶</a></h1>
<p>report status of monitors</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph mon_status
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="node-ls">
<h1>node ls<a class="headerlink" href="#node-ls" title="Permalink to this headline">¶</a></h1>
<p>list all nodes in cluster [type]</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph node ls all
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>type</strong>: CephChoices  strings=(all osd mon mds mgr)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="ops">
<h1>ops<a class="headerlink" href="#ops" title="Permalink to this headline">¶</a></h1>
<p>show the ops currently in flight</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph ops
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="id9">
<h1>osd<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h1>
<div class="section" id="osd-add-nodown">
<h2>osd add-nodown<a class="headerlink" href="#osd-add-nodown" title="Permalink to this headline">¶</a></h2>
<p>mark osd(s) &lt;id&gt; [&lt;id&gt;…] as nodown, or use &lt;all|any&gt; to mark all
osds as nodown</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd add-nodown --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-add-noin">
<h2>osd add-noin<a class="headerlink" href="#osd-add-noin" title="Permalink to this headline">¶</a></h2>
<p>mark osd(s) &lt;id&gt; [&lt;id&gt;…] as noin, or use &lt;all|any&gt; to mark all osds
as noin</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd add-noin --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-add-noout">
<h2>osd add-noout<a class="headerlink" href="#osd-add-noout" title="Permalink to this headline">¶</a></h2>
<p>mark osd(s) &lt;id&gt; [&lt;id&gt;…] as noout, or use &lt;all|any&gt; to mark all osds
as noout</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd add-noout --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-add-noup">
<h2>osd add-noup<a class="headerlink" href="#osd-add-noup" title="Permalink to this headline">¶</a></h2>
<p>mark osd(s) &lt;id&gt; [&lt;id&gt;…] as noup, or use &lt;all|any&gt; to mark all osds
as noup</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd add-noup --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-blacklist">
<h2>osd blacklist<a class="headerlink" href="#osd-blacklist" title="Permalink to this headline">¶</a></h2>
<p>add (optionally until &lt;expire&gt; seconds from now) or remove &lt;addr&gt; from
blacklist</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd blacklist add entityaddr <span class="m">0</span>.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>blacklistop</strong>: CephChoices  strings=(add rm)</p></li>
<li><p><strong>addr</strong>: CephEntityAddr</p></li>
<li><p><strong>expire</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-blacklist-clear">
<h2>osd blacklist clear<a class="headerlink" href="#osd-blacklist-clear" title="Permalink to this headline">¶</a></h2>
<p>clear all blacklisted clients</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd blacklist clear
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-blacklist-ls">
<h2>osd blacklist ls<a class="headerlink" href="#osd-blacklist-ls" title="Permalink to this headline">¶</a></h2>
<p>show blacklisted clients</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd blacklist ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-blocked-by">
<h2>osd blocked-by<a class="headerlink" href="#osd-blocked-by" title="Permalink to this headline">¶</a></h2>
<p>print histogram of which OSDs are blocking their peers</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd blocked-by
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-blocklist">
<h2>osd blocklist<a class="headerlink" href="#osd-blocklist" title="Permalink to this headline">¶</a></h2>
<p>add (optionally until &lt;expire&gt; seconds from now) or remove &lt;addr&gt; from
blocklist</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd blocklist add entityaddr <span class="m">0</span>.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>blocklistop</strong>: CephChoices  strings=(add rm)</p></li>
<li><p><strong>addr</strong>: CephEntityAddr</p></li>
<li><p><strong>expire</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-blocklist-clear">
<h2>osd blocklist clear<a class="headerlink" href="#osd-blocklist-clear" title="Permalink to this headline">¶</a></h2>
<p>clear all blocklisted clients</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd blocklist clear
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-blocklist-ls">
<h2>osd blocklist ls<a class="headerlink" href="#osd-blocklist-ls" title="Permalink to this headline">¶</a></h2>
<p>show blocklisted clients</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd blocklist ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-count-metadata">
<h2>osd count-metadata<a class="headerlink" href="#osd-count-metadata" title="Permalink to this headline">¶</a></h2>
<p>count OSDs by metadata field property</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd count-metadata my_property
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>property</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-create">
<h2>osd create<a class="headerlink" href="#osd-create" title="Permalink to this headline">¶</a></h2>
<p>create new osd (with optional UUID and ID)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd create uuid osd.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>uuid</strong>: CephUUID</p></li>
<li><p><strong>id</strong>: CephOsdName</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-add">
<h2>osd crush add<a class="headerlink" href="#osd-crush-add" title="Permalink to this headline">¶</a></h2>
<p>add or update crushmap position and weight for &lt;name&gt; with &lt;weight&gt;
and location &lt;args&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush add --id<span class="o">=</span>osd.0 --weight<span class="o">=</span><span class="m">0</span>.0 --args<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
<li><p><strong>weight</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0</span></code></p></li>
<li><p><strong>args</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.=]</span></code>  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-add-bucket">
<h2>osd crush add-bucket<a class="headerlink" href="#osd-crush-add-bucket" title="Permalink to this headline">¶</a></h2>
<p>add no-parent (probably root) crush bucket &lt;name&gt; of type &lt;type&gt; to
location &lt;args&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush add-bucket --name<span class="o">=</span>string --type<span class="o">=</span>string --args<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>type</strong>: (string)</p></li>
<li><p><strong>args</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.=]</span></code>  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-class-create">
<h2>osd crush class create<a class="headerlink" href="#osd-crush-class-create" title="Permalink to this headline">¶</a></h2>
<p>create crush device class &lt;class&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush class create my_class
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>class</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-class-ls">
<h2>osd crush class ls<a class="headerlink" href="#osd-crush-class-ls" title="Permalink to this headline">¶</a></h2>
<p>list all crush device classes</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush class ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-class-ls-osd">
<h2>osd crush class ls-osd<a class="headerlink" href="#osd-crush-class-ls-osd" title="Permalink to this headline">¶</a></h2>
<p>list all osds belonging to the specific &lt;class&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush class ls-osd my_class
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>class</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-class-rename">
<h2>osd crush class rename<a class="headerlink" href="#osd-crush-class-rename" title="Permalink to this headline">¶</a></h2>
<p>rename crush device class &lt;srcname&gt; to &lt;dstname&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush class rename my_srcname my_dstname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>srcname</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_]</span></code></p></li>
<li><p><strong>dstname</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-class-rm">
<h2>osd crush class rm<a class="headerlink" href="#osd-crush-class-rm" title="Permalink to this headline">¶</a></h2>
<p>remove crush device class &lt;class&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush class rm my_class
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>class</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-create-or-move">
<h2>osd crush create-or-move<a class="headerlink" href="#osd-crush-create-or-move" title="Permalink to this headline">¶</a></h2>
<p>create entry or move existing entry for &lt;name&gt; &lt;weight&gt; at/to location
&lt;args&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush create-or-move --id<span class="o">=</span>osd.0 --weight<span class="o">=</span><span class="m">0</span>.0 --args<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
<li><p><strong>weight</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0</span></code></p></li>
<li><p><strong>args</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.=]</span></code>  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-dump">
<h2>osd crush dump<a class="headerlink" href="#osd-crush-dump" title="Permalink to this headline">¶</a></h2>
<p>dump crush map</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush dump
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-get-device-class">
<h2>osd crush get-device-class<a class="headerlink" href="#osd-crush-get-device-class" title="Permalink to this headline">¶</a></h2>
<p>get classes of specified osd(s) &lt;id&gt; [&lt;id&gt;…]</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush get-device-class --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-get-tunable">
<h2>osd crush get-tunable<a class="headerlink" href="#osd-crush-get-tunable" title="Permalink to this headline">¶</a></h2>
<p>get crush tunable &lt;tunable&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush get-tunable straw_calc_version
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>tunable</strong>: CephChoices  strings=(straw_calc_version)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-link">
<h2>osd crush link<a class="headerlink" href="#osd-crush-link" title="Permalink to this headline">¶</a></h2>
<p>link existing entry for &lt;name&gt; under location &lt;args&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush link --name<span class="o">=</span>string --args<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
<li><p><strong>args</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.=]</span></code>  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-ls">
<h2>osd crush ls<a class="headerlink" href="#osd-crush-ls" title="Permalink to this headline">¶</a></h2>
<p>list items beneath a node in the CRUSH tree</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush ls my_node
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>node</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-move">
<h2>osd crush move<a class="headerlink" href="#osd-crush-move" title="Permalink to this headline">¶</a></h2>
<p>move existing entry for &lt;name&gt; to location &lt;args&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush move --name<span class="o">=</span>string --args<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>args</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.=]</span></code>  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-remove">
<h2>osd crush remove<a class="headerlink" href="#osd-crush-remove" title="Permalink to this headline">¶</a></h2>
<p>remove &lt;name&gt; from crush map (everywhere, or just at &lt;ancestor&gt;)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush remove my_name my_ancestor
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>ancestor</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-rename-bucket">
<h2>osd crush rename-bucket<a class="headerlink" href="#osd-crush-rename-bucket" title="Permalink to this headline">¶</a></h2>
<p>rename bucket &lt;srcname&gt; to &lt;dstname&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush rename-bucket my_srcname my_dstname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>srcname</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>dstname</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-reweight">
<h2>osd crush reweight<a class="headerlink" href="#osd-crush-reweight" title="Permalink to this headline">¶</a></h2>
<p>change &lt;name&gt;’s weight to &lt;weight&gt; in crush map</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush reweight my_name <span class="m">0</span>.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>weight</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-reweight-all">
<h2>osd crush reweight-all<a class="headerlink" href="#osd-crush-reweight-all" title="Permalink to this headline">¶</a></h2>
<p>recalculate the weights for the tree to ensure they sum correctly</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush reweight-all
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-reweight-subtree">
<h2>osd crush reweight-subtree<a class="headerlink" href="#osd-crush-reweight-subtree" title="Permalink to this headline">¶</a></h2>
<p>change all leaf items beneath &lt;name&gt; to &lt;weight&gt; in crush map</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush reweight-subtree my_name <span class="m">0</span>.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>weight</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-rm">
<h2>osd crush rm<a class="headerlink" href="#osd-crush-rm" title="Permalink to this headline">¶</a></h2>
<p>remove &lt;name&gt; from crush map (everywhere, or just at &lt;ancestor&gt;)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush rm my_name my_ancestor
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>ancestor</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-rm-device-class">
<h2>osd crush rm-device-class<a class="headerlink" href="#osd-crush-rm-device-class" title="Permalink to this headline">¶</a></h2>
<p>remove class of the osd(s) &lt;id&gt; [&lt;id&gt;…],or use &lt;all|any&gt; to remove
all.</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush rm-device-class --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-rule-create-erasure">
<h2>osd crush rule create-erasure<a class="headerlink" href="#osd-crush-rule-create-erasure" title="Permalink to this headline">¶</a></h2>
<p>create crush rule &lt;name&gt; for erasure coded pool created with &lt;profile&gt;
(default default)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush rule create-erasure my_name my_profile
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>profile</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.=]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-rule-create-replicated">
<h2>osd crush rule create-replicated<a class="headerlink" href="#osd-crush-rule-create-replicated" title="Permalink to this headline">¶</a></h2>
<p>create crush rule &lt;name&gt; for replicated pool to start from &lt;root&gt;,
replicate across buckets of type &lt;type&gt;, use devices of type &lt;class&gt;
(ssd or hdd)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush rule create-replicated --name<span class="o">=</span>string --root<span class="o">=</span>string
  --type<span class="o">=</span>string --class<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>root</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>type</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>class</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-rule-create-simple">
<h2>osd crush rule create-simple<a class="headerlink" href="#osd-crush-rule-create-simple" title="Permalink to this headline">¶</a></h2>
<p>create crush rule &lt;name&gt; to start from &lt;root&gt;, replicate across
buckets of type &lt;type&gt;, using a choose mode of &lt;firstn|indep&gt; (default
firstn; indep best for erasure pools)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush rule create-simple --name<span class="o">=</span>string --root<span class="o">=</span>string
  --type<span class="o">=</span>string --mode<span class="o">=</span>firstn
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>root</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>type</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>mode</strong>: CephChoices  strings=(firstn indep)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-rule-dump">
<h2>osd crush rule dump<a class="headerlink" href="#osd-crush-rule-dump" title="Permalink to this headline">¶</a></h2>
<p>dump crush rule &lt;name&gt; (default all)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush rule dump my_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-rule-list">
<h2>osd crush rule list<a class="headerlink" href="#osd-crush-rule-list" title="Permalink to this headline">¶</a></h2>
<p>list crush rules</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush rule list
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-rule-ls">
<h2>osd crush rule ls<a class="headerlink" href="#osd-crush-rule-ls" title="Permalink to this headline">¶</a></h2>
<p>list crush rules</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush rule ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-rule-ls-by-class">
<h2>osd crush rule ls-by-class<a class="headerlink" href="#osd-crush-rule-ls-by-class" title="Permalink to this headline">¶</a></h2>
<p>list all crush rules that reference the same &lt;class&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush rule ls-by-class my_class
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>class</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-rule-rename">
<h2>osd crush rule rename<a class="headerlink" href="#osd-crush-rule-rename" title="Permalink to this headline">¶</a></h2>
<p>rename crush rule &lt;srcname&gt; to &lt;dstname&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush rule rename my_srcname my_dstname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>srcname</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>dstname</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-rule-rm">
<h2>osd crush rule rm<a class="headerlink" href="#osd-crush-rule-rm" title="Permalink to this headline">¶</a></h2>
<p>remove crush rule &lt;name&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush rule rm my_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-set">
<h2>osd crush set<a class="headerlink" href="#osd-crush-set" title="Permalink to this headline">¶</a></h2>
<p>set crush map from input file</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush <span class="nb">set</span> <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>prior_version</strong>: CephInt</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="id10">
<h2>osd crush set<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h2>
<p>update crushmap position and weight for &lt;name&gt; to &lt;weight&gt; with
location &lt;args&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush <span class="nb">set</span> --id<span class="o">=</span>osd.0 --weight<span class="o">=</span><span class="m">0</span>.0 --args<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
<li><p><strong>weight</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0</span></code></p></li>
<li><p><strong>args</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.=]</span></code>  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-set-all-straw-buckets-to-straw2">
<h2>osd crush set-all-straw-buckets-to-straw2<a class="headerlink" href="#osd-crush-set-all-straw-buckets-to-straw2" title="Permalink to this headline">¶</a></h2>
<p>convert all CRUSH current straw buckets to use the straw2 algorithm</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush set-all-straw-buckets-to-straw2
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-set-device-class">
<h2>osd crush set-device-class<a class="headerlink" href="#osd-crush-set-device-class" title="Permalink to this headline">¶</a></h2>
<p>set the &lt;class&gt; of the osd(s) &lt;id&gt; [&lt;id&gt;…],or use &lt;all|any&gt; to set
all.</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush set-device-class --class<span class="o">=</span>string --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>class</strong>: (string)</p></li>
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-set-tunable">
<h2>osd crush set-tunable<a class="headerlink" href="#osd-crush-set-tunable" title="Permalink to this headline">¶</a></h2>
<p>set crush tunable &lt;tunable&gt; to &lt;value&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush set-tunable straw_calc_version <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>tunable</strong>: CephChoices  strings=(straw_calc_version)</p></li>
<li><p><strong>value</strong>: CephInt</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-show-tunables">
<h2>osd crush show-tunables<a class="headerlink" href="#osd-crush-show-tunables" title="Permalink to this headline">¶</a></h2>
<p>show current crush tunables</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush show-tunables
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-swap-bucket">
<h2>osd crush swap-bucket<a class="headerlink" href="#osd-crush-swap-bucket" title="Permalink to this headline">¶</a></h2>
<p>swap existing bucket contents from (orphan) bucket &lt;source&gt; and
&lt;target&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush swap-bucket my_source my_dest --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>source</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>dest</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-tree">
<h2>osd crush tree<a class="headerlink" href="#osd-crush-tree" title="Permalink to this headline">¶</a></h2>
<p>dump crush buckets and items in a tree view</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush tree --show_shadow
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>show_shadow</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-tunables">
<h2>osd crush tunables<a class="headerlink" href="#osd-crush-tunables" title="Permalink to this headline">¶</a></h2>
<p>set crush tunables values to &lt;profile&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush tunables legacy
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>profile</strong>: CephChoices  strings=(legacy argonaut bobtail firefly hammer jewel optimal default)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-unlink">
<h2>osd crush unlink<a class="headerlink" href="#osd-crush-unlink" title="Permalink to this headline">¶</a></h2>
<p>unlink &lt;name&gt; from crush map (everywhere, or just at &lt;ancestor&gt;)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush unlink my_name my_ancestor
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>ancestor</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-weight-set-create">
<h2>osd crush weight-set create<a class="headerlink" href="#osd-crush-weight-set-create" title="Permalink to this headline">¶</a></h2>
<p>create a weight-set for a given pool</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush weight-set create poolname flat
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>mode</strong>: CephChoices  strings=(flat positional)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-weight-set-create-compat">
<h2>osd crush weight-set create-compat<a class="headerlink" href="#osd-crush-weight-set-create-compat" title="Permalink to this headline">¶</a></h2>
<p>create a default backward-compatible weight-set</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush weight-set create-compat
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-weight-set-dump">
<h2>osd crush weight-set dump<a class="headerlink" href="#osd-crush-weight-set-dump" title="Permalink to this headline">¶</a></h2>
<p>dump crush weight sets</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush weight-set dump
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-weight-set-ls">
<h2>osd crush weight-set ls<a class="headerlink" href="#osd-crush-weight-set-ls" title="Permalink to this headline">¶</a></h2>
<p>list crush weight sets</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush weight-set ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-weight-set-reweight">
<h2>osd crush weight-set reweight<a class="headerlink" href="#osd-crush-weight-set-reweight" title="Permalink to this headline">¶</a></h2>
<p>set weight for an item (bucket or osd) in a pool’s weight-set</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush weight-set reweight --pool<span class="o">=</span>poolname --item<span class="o">=</span>string
  --weight<span class="o">=</span><span class="m">0</span>.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>item</strong>: (string)</p></li>
<li><p><strong>weight</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0</span></code>  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-weight-set-reweight-compat">
<h2>osd crush weight-set reweight-compat<a class="headerlink" href="#osd-crush-weight-set-reweight-compat" title="Permalink to this headline">¶</a></h2>
<p>set weight for an item (bucket or osd) in the backward-compatible
weight-set</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush weight-set reweight-compat --item<span class="o">=</span>string --weight<span class="o">=</span><span class="m">0</span>.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>item</strong>: (string)</p></li>
<li><p><strong>weight</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0</span></code>  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-weight-set-rm">
<h2>osd crush weight-set rm<a class="headerlink" href="#osd-crush-weight-set-rm" title="Permalink to this headline">¶</a></h2>
<p>remove the weight-set for a given pool</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush weight-set rm poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-crush-weight-set-rm-compat">
<h2>osd crush weight-set rm-compat<a class="headerlink" href="#osd-crush-weight-set-rm-compat" title="Permalink to this headline">¶</a></h2>
<p>remove the backward-compatible weight-set</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd crush weight-set rm-compat
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-deep-scrub">
<h2>osd deep-scrub<a class="headerlink" href="#osd-deep-scrub" title="Permalink to this headline">¶</a></h2>
<p>initiate deep scrub on osd &lt;who&gt;, or use &lt;all|any&gt; to deep scrub all</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd deep-scrub string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-destroy">
<h2>osd destroy<a class="headerlink" href="#osd-destroy" title="Permalink to this headline">¶</a></h2>
<p>mark osd as being destroyed. Keeps the ID intact (allowing reuse), but
removes cephx keys, config-key data and lockbox keys, rendering data
permanently unreadable.</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd destroy osd.0 --force --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
<li><p><strong>force</strong>: CephBool</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-df">
<h2>osd df<a class="headerlink" href="#osd-df" title="Permalink to this headline">¶</a></h2>
<p>show OSD utilization</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd df plain class my_filter
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>output_method</strong>: CephChoices  strings=(plain tree)</p></li>
<li><p><strong>filter_by</strong>: CephChoices  strings=(class name)</p></li>
<li><p><strong>filter</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-down">
<h2>osd down<a class="headerlink" href="#osd-down" title="Permalink to this headline">¶</a></h2>
<p>set osd(s) &lt;id&gt; [&lt;id&gt;…] down, or use &lt;any|all&gt; to set all osds down</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd down --ids<span class="o">=</span>string --definitely_dead
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
<li><p><strong>definitely_dead</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-dump">
<h2>osd dump<a class="headerlink" href="#osd-dump" title="Permalink to this headline">¶</a></h2>
<p>print summary of OSD map</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd dump <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>epoch</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-erasure-code-profile-get">
<h2>osd erasure-code-profile get<a class="headerlink" href="#osd-erasure-code-profile-get" title="Permalink to this headline">¶</a></h2>
<p>get erasure code profile &lt;name&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd erasure-code-profile get my_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-erasure-code-profile-ls">
<h2>osd erasure-code-profile ls<a class="headerlink" href="#osd-erasure-code-profile-ls" title="Permalink to this headline">¶</a></h2>
<p>list all erasure code profiles</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd erasure-code-profile ls
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-erasure-code-profile-rm">
<h2>osd erasure-code-profile rm<a class="headerlink" href="#osd-erasure-code-profile-rm" title="Permalink to this headline">¶</a></h2>
<p>remove erasure code profile &lt;name&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd erasure-code-profile rm my_name
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-erasure-code-profile-set">
<h2>osd erasure-code-profile set<a class="headerlink" href="#osd-erasure-code-profile-set" title="Permalink to this headline">¶</a></h2>
<p>create erasure code profile &lt;name&gt; with [&lt;key[=value]&gt; …] pairs. Add
a –force at the end to override an existing profile (VERY DANGEROUS)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd erasure-code-profile <span class="nb">set</span> --name<span class="o">=</span>string --profile<span class="o">=</span>string
  --force
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>profile</strong>: (can be repeated)</p></li>
<li><p><strong>force</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-find">
<h2>osd find<a class="headerlink" href="#osd-find" title="Permalink to this headline">¶</a></h2>
<p>find osd &lt;id&gt; in the CRUSH map and show its location</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd find osd.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-force-create-pg">
<h2>osd force-create-pg<a class="headerlink" href="#osd-force-create-pg" title="Permalink to this headline">¶</a></h2>
<p>force creation of pg &lt;pgid&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd force-create-pg <span class="m">0</span> --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-force-healthy-stretch-mode">
<h2>osd force_healthy_stretch_mode<a class="headerlink" href="#osd-force-healthy-stretch-mode" title="Permalink to this headline">¶</a></h2>
<p>force a healthy stretch mode, requiring the full number of CRUSH
buckets to peer and letting all non-tiebreaker monitors be elected
leader</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd force_healthy_stretch_mode --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-force-recovery-stretch-mode">
<h2>osd force_recovery_stretch_mode<a class="headerlink" href="#osd-force-recovery-stretch-mode" title="Permalink to this headline">¶</a></h2>
<p>try and force a recovery stretch mode, increasing the pool size to its
non-failure value if currently degraded and all monitor buckets are up</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd force_recovery_stretch_mode --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-get-require-min-compat-client">
<h2>osd get-require-min-compat-client<a class="headerlink" href="#osd-get-require-min-compat-client" title="Permalink to this headline">¶</a></h2>
<p>get the minimum client version we will maintain compatibility with</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd get-require-min-compat-client
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-getcrushmap">
<h2>osd getcrushmap<a class="headerlink" href="#osd-getcrushmap" title="Permalink to this headline">¶</a></h2>
<p>get CRUSH map</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd getcrushmap <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>epoch</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-getmap">
<h2>osd getmap<a class="headerlink" href="#osd-getmap" title="Permalink to this headline">¶</a></h2>
<p>get OSD map</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd getmap <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>epoch</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-getmaxosd">
<h2>osd getmaxosd<a class="headerlink" href="#osd-getmaxosd" title="Permalink to this headline">¶</a></h2>
<p>show largest OSD id</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd getmaxosd
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-in">
<h2>osd in<a class="headerlink" href="#osd-in" title="Permalink to this headline">¶</a></h2>
<p>set osd(s) &lt;id&gt; [&lt;id&gt;…] in, can use &lt;any|all&gt; to automatically set
all previously out osds in</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd <span class="k">in</span> --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-info">
<h2>osd info<a class="headerlink" href="#osd-info" title="Permalink to this headline">¶</a></h2>
<p>print osd’s {id} information (instead of all osds from map)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd info osd.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-last-stat-seq">
<h2>osd last-stat-seq<a class="headerlink" href="#osd-last-stat-seq" title="Permalink to this headline">¶</a></h2>
<p>get the last pg stats sequence number reported for this osd</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd last-stat-seq osd.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-lost">
<h2>osd lost<a class="headerlink" href="#osd-lost" title="Permalink to this headline">¶</a></h2>
<p>mark osd as permanently lost. THIS DESTROYS DATA IF NO MORE REPLICAS
EXIST, BE CAREFUL</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd lost osd.0 --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-ls">
<h2>osd ls<a class="headerlink" href="#osd-ls" title="Permalink to this headline">¶</a></h2>
<p>show all OSD ids</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd ls <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>epoch</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-ls-tree">
<h2>osd ls-tree<a class="headerlink" href="#osd-ls-tree" title="Permalink to this headline">¶</a></h2>
<p>show OSD ids under bucket &lt;name&gt; in the CRUSH map</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd ls-tree my_name <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>name</strong>: (string)</p></li>
<li><p><strong>epoch</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-lspools">
<h2>osd lspools<a class="headerlink" href="#osd-lspools" title="Permalink to this headline">¶</a></h2>
<p>list pools</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd lspools
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
<dt class="field-even">Command Flags</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-map">
<h2>osd map<a class="headerlink" href="#osd-map" title="Permalink to this headline">¶</a></h2>
<p>find pg for &lt;object&gt; in &lt;pool&gt; with [namespace]</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd map poolname objectname my_nspace
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>object</strong>: CephObjectname</p></li>
<li><p><strong>nspace</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-metadata">
<h2>osd metadata<a class="headerlink" href="#osd-metadata" title="Permalink to this headline">¶</a></h2>
<p>fetch metadata for osd {id} (default all)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd metadata osd.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-new">
<h2>osd new<a class="headerlink" href="#osd-new" title="Permalink to this headline">¶</a></h2>
<p>Create a new OSD. If supplied, the <cite>id</cite> to be replaced needs to exist
and have been previously destroyed. Reads secrets from JSON file via
<cite>-i &lt;file&gt;</cite> (see man page).</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd new uuid osd.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>uuid</strong>: CephUUID</p></li>
<li><p><strong>id</strong>: CephOsdName</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-numa-status">
<h2>osd numa-status<a class="headerlink" href="#osd-numa-status" title="Permalink to this headline">¶</a></h2>
<p>show NUMA status of OSDs</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd numa-status
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-ok-to-stop">
<h2>osd ok-to-stop<a class="headerlink" href="#osd-ok-to-stop" title="Permalink to this headline">¶</a></h2>
<p>check whether osd(s) can be safely stopped without reducing immediate
data availability</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd ok-to-stop --ids<span class="o">=</span>string --max<span class="o">=</span><span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
<li><p><strong>max</strong>: CephInt</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-out">
<h2>osd out<a class="headerlink" href="#osd-out" title="Permalink to this headline">¶</a></h2>
<p>set osd(s) &lt;id&gt; [&lt;id&gt;…] out, or use &lt;any|all&gt; to set all osds out</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd out --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pause">
<h2>osd pause<a class="headerlink" href="#osd-pause" title="Permalink to this headline">¶</a></h2>
<p>pause osd</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pause
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-perf">
<h2>osd perf<a class="headerlink" href="#osd-perf" title="Permalink to this headline">¶</a></h2>
<p>print dump of OSD perf summary stats</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd perf
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pg-temp">
<h2>osd pg-temp<a class="headerlink" href="#osd-pg-temp" title="Permalink to this headline">¶</a></h2>
<p>set pg_temp mapping pgid:[&lt;id&gt; [&lt;id&gt;…]] (developers only)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pg-temp --pgid<span class="o">=</span><span class="m">0</span> --id<span class="o">=</span>osd.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid</p></li>
<li><p><strong>id</strong>: CephOsdName  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pg-upmap">
<h2>osd pg-upmap<a class="headerlink" href="#osd-pg-upmap" title="Permalink to this headline">¶</a></h2>
<p>set pg_upmap mapping &lt;pgid&gt;:[&lt;id&gt; [&lt;id&gt;…]] (developers only)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pg-upmap --pgid<span class="o">=</span><span class="m">0</span> --id<span class="o">=</span>osd.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid</p></li>
<li><p><strong>id</strong>: CephOsdName  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pg-upmap-items">
<h2>osd pg-upmap-items<a class="headerlink" href="#osd-pg-upmap-items" title="Permalink to this headline">¶</a></h2>
<p>set pg_upmap_items mapping &lt;pgid&gt;:{&lt;id&gt; to &lt;id&gt;, […]} (developers
only)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pg-upmap-items --pgid<span class="o">=</span><span class="m">0</span> --id<span class="o">=</span>osd.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid</p></li>
<li><p><strong>id</strong>: CephOsdName  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-application-disable">
<h2>osd pool application disable<a class="headerlink" href="#osd-pool-application-disable" title="Permalink to this headline">¶</a></h2>
<p>disables use of an application &lt;app&gt; on pool &lt;poolname&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool application disable poolname my_app
  --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>app</strong>: (string)</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-application-enable">
<h2>osd pool application enable<a class="headerlink" href="#osd-pool-application-enable" title="Permalink to this headline">¶</a></h2>
<p>enable use of an application &lt;app&gt; [cephfs,rbd,rgw] on pool &lt;poolname&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool application <span class="nb">enable</span> poolname my_app
  --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>app</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-application-get">
<h2>osd pool application get<a class="headerlink" href="#osd-pool-application-get" title="Permalink to this headline">¶</a></h2>
<p>get value of key &lt;key&gt; of application &lt;app&gt; on pool &lt;poolname&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool application get poolname my_app my_key
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>app</strong>: (string)</p></li>
<li><p><strong>key</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-application-rm">
<h2>osd pool application rm<a class="headerlink" href="#osd-pool-application-rm" title="Permalink to this headline">¶</a></h2>
<p>removes application &lt;app&gt; metadata key &lt;key&gt; on pool &lt;poolname&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool application rm poolname my_app my_key
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>app</strong>: (string)</p></li>
<li><p><strong>key</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-application-set">
<h2>osd pool application set<a class="headerlink" href="#osd-pool-application-set" title="Permalink to this headline">¶</a></h2>
<p>sets application &lt;app&gt; metadata key &lt;key&gt; to &lt;value&gt; on pool
&lt;poolname&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool application <span class="nb">set</span> --pool<span class="o">=</span>poolname --app<span class="o">=</span>string
  --key<span class="o">=</span>string --value<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>app</strong>: (string)</p></li>
<li><p><strong>key</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>value</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.=]</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-cancel-force-backfill">
<h2>osd pool cancel-force-backfill<a class="headerlink" href="#osd-pool-cancel-force-backfill" title="Permalink to this headline">¶</a></h2>
<p>restore normal recovery priority of specified pool &lt;who&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool cancel-force-backfill --who<span class="o">=</span>poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: CephPoolname  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-cancel-force-recovery">
<h2>osd pool cancel-force-recovery<a class="headerlink" href="#osd-pool-cancel-force-recovery" title="Permalink to this headline">¶</a></h2>
<p>restore normal recovery priority of specified pool &lt;who&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool cancel-force-recovery --who<span class="o">=</span>poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: CephPoolname  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-create">
<h2>osd pool create<a class="headerlink" href="#osd-pool-create" title="Permalink to this headline">¶</a></h2>
<p>create pool</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool create --pool<span class="o">=</span>poolname --pg_num<span class="o">=</span><span class="m">0</span> --pgp_num<span class="o">=</span><span class="m">0</span>
  --pool_type<span class="o">=</span>replicated --erasure_code_profile<span class="o">=</span>string --rule<span class="o">=</span>string
  --expected_num_objects<span class="o">=</span><span class="m">0</span> --size<span class="o">=</span><span class="m">0</span> --pg_num_min<span class="o">=</span><span class="m">0</span> --pg_num_max<span class="o">=</span><span class="m">0</span>
  --autoscale_mode<span class="o">=</span>on --bulk --target_size_bytes<span class="o">=</span><span class="m">0</span> --target_size_ratio<span class="o">=</span><span class="m">0</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>pg_num</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
<li><p><strong>pgp_num</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
<li><p><strong>pool_type</strong>: CephChoices  strings=(replicated erasure)</p></li>
<li><p><strong>erasure_code_profile</strong>: goodchars= <code class="docutils literal notranslate"><span class="pre">[A-Za-z0-9-_.]</span></code></p></li>
<li><p><strong>rule</strong>: (string)</p></li>
<li><p><strong>expected_num_objects</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
<li><p><strong>size</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
<li><p><strong>pg_num_min</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
<li><p><strong>pg_num_max</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
<li><p><strong>autoscale_mode</strong>: CephChoices  strings=(on off warn)</p></li>
<li><p><strong>bulk</strong>: CephBool</p></li>
<li><p><strong>target_size_bytes</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
<li><p><strong>target_size_ratio</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0..1</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-deep-scrub">
<h2>osd pool deep-scrub<a class="headerlink" href="#osd-pool-deep-scrub" title="Permalink to this headline">¶</a></h2>
<p>initiate deep-scrub on pool &lt;who&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool deep-scrub --who<span class="o">=</span>poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: CephPoolname  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-delete">
<h2>osd pool delete<a class="headerlink" href="#osd-pool-delete" title="Permalink to this headline">¶</a></h2>
<p>delete pool</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool delete --pool<span class="o">=</span>poolname --pool2<span class="o">=</span>poolname
  --yes_i_really_really_mean_it --yes_i_really_really_mean_it_not_faking
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>pool2</strong>: CephPoolname</p></li>
<li><p><strong>yes_i_really_really_mean_it</strong>: CephBool</p></li>
<li><p><strong>yes_i_really_really_mean_it_not_faking</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-force-backfill">
<h2>osd pool force-backfill<a class="headerlink" href="#osd-pool-force-backfill" title="Permalink to this headline">¶</a></h2>
<p>force backfill of specified pool &lt;who&gt; first</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool force-backfill --who<span class="o">=</span>poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: CephPoolname  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-force-recovery">
<h2>osd pool force-recovery<a class="headerlink" href="#osd-pool-force-recovery" title="Permalink to this headline">¶</a></h2>
<p>force recovery of specified pool &lt;who&gt; first</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool force-recovery --who<span class="o">=</span>poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: CephPoolname  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-get">
<h2>osd pool get<a class="headerlink" href="#osd-pool-get" title="Permalink to this headline">¶</a></h2>
<p>get pool parameter &lt;var&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool get poolname size
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>var</strong>: CephChoices  strings=(size min_size pg_num pgp_num crush_rule hashpspool nodelete nopgchange nosizechange write_fadvise_dontneed noscrub nodeep-scrub hit_set_type hit_set_period hit_set_count hit_set_fpp use_gmt_hitset target_max_objects target_max_bytes cache_target_dirty_ratio cache_target_dirty_high_ratio cache_target_full_ratio cache_min_flush_age cache_min_evict_age erasure_code_profile min_read_recency_for_promote all min_write_recency_for_promote fast_read hit_set_grade_decay_rate hit_set_search_last_n scrub_min_interval scrub_max_interval deep_scrub_interval recovery_priority recovery_op_priority scrub_priority compression_mode compression_algorithm compression_required_ratio compression_max_blob_size compression_min_blob_size csum_type csum_min_block csum_max_block allow_ec_overwrites fingerprint_algorithm pg_autoscale_mode pg_autoscale_bias pg_num_min pg_num_max target_size_bytes target_size_ratio dedup_tier dedup_chunk_algorithm dedup_cdc_chunk_size eio bulk)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-get-quota">
<h2>osd pool get-quota<a class="headerlink" href="#osd-pool-get-quota" title="Permalink to this headline">¶</a></h2>
<p>obtain object or byte limits for pool</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool get-quota poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-ls">
<h2>osd pool ls<a class="headerlink" href="#osd-pool-ls" title="Permalink to this headline">¶</a></h2>
<p>list pools</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool ls detail
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>detail</strong>: CephChoices  strings=(detail)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-mksnap">
<h2>osd pool mksnap<a class="headerlink" href="#osd-pool-mksnap" title="Permalink to this headline">¶</a></h2>
<p>make snapshot &lt;snap&gt; in &lt;pool&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool mksnap poolname my_snap
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>snap</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-rename">
<h2>osd pool rename<a class="headerlink" href="#osd-pool-rename" title="Permalink to this headline">¶</a></h2>
<p>rename &lt;srcpool&gt; to &lt;destpool&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool rename poolname poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>srcpool</strong>: CephPoolname</p></li>
<li><p><strong>destpool</strong>: CephPoolname</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-repair">
<h2>osd pool repair<a class="headerlink" href="#osd-pool-repair" title="Permalink to this headline">¶</a></h2>
<p>initiate repair on pool &lt;who&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool repair --who<span class="o">=</span>poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: CephPoolname  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-rm">
<h2>osd pool rm<a class="headerlink" href="#osd-pool-rm" title="Permalink to this headline">¶</a></h2>
<p>remove pool</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool rm --pool<span class="o">=</span>poolname --pool2<span class="o">=</span>poolname
  --yes_i_really_really_mean_it --yes_i_really_really_mean_it_not_faking
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>pool2</strong>: CephPoolname</p></li>
<li><p><strong>yes_i_really_really_mean_it</strong>: CephBool</p></li>
<li><p><strong>yes_i_really_really_mean_it_not_faking</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-rmsnap">
<h2>osd pool rmsnap<a class="headerlink" href="#osd-pool-rmsnap" title="Permalink to this headline">¶</a></h2>
<p>remove snapshot &lt;snap&gt; from &lt;pool&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool rmsnap poolname my_snap
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>snap</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-scrub">
<h2>osd pool scrub<a class="headerlink" href="#osd-pool-scrub" title="Permalink to this headline">¶</a></h2>
<p>initiate scrub on pool &lt;who&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool scrub --who<span class="o">=</span>poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: CephPoolname  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-set">
<h2>osd pool set<a class="headerlink" href="#osd-pool-set" title="Permalink to this headline">¶</a></h2>
<p>set pool parameter &lt;var&gt; to &lt;val&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool <span class="nb">set</span> --pool<span class="o">=</span>poolname --var<span class="o">=</span>size --val<span class="o">=</span>string
  --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>var</strong>: CephChoices  strings=(size min_size pg_num pgp_num pgp_num_actual crush_rule hashpspool nodelete nopgchange nosizechange write_fadvise_dontneed noscrub nodeep-scrub hit_set_type hit_set_period hit_set_count hit_set_fpp use_gmt_hitset target_max_bytes target_max_objects cache_target_dirty_ratio cache_target_dirty_high_ratio cache_target_full_ratio cache_min_flush_age cache_min_evict_age min_read_recency_for_promote min_write_recency_for_promote fast_read hit_set_grade_decay_rate hit_set_search_last_n scrub_min_interval scrub_max_interval deep_scrub_interval recovery_priority recovery_op_priority scrub_priority compression_mode compression_algorithm compression_required_ratio compression_max_blob_size compression_min_blob_size csum_type csum_min_block csum_max_block allow_ec_overwrites fingerprint_algorithm pg_autoscale_mode pg_autoscale_bias pg_num_min pg_num_max target_size_bytes target_size_ratio dedup_tier dedup_chunk_algorithm dedup_cdc_chunk_size eio bulk)</p></li>
<li><p><strong>val</strong>: (string)</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-set-quota">
<h2>osd pool set-quota<a class="headerlink" href="#osd-pool-set-quota" title="Permalink to this headline">¶</a></h2>
<p>set object or byte limit on pool</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool set-quota poolname max_objects my_val
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>field</strong>: CephChoices  strings=(max_objects max_bytes)</p></li>
<li><p><strong>val</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-pool-stats">
<h2>osd pool stats<a class="headerlink" href="#osd-pool-stats" title="Permalink to this headline">¶</a></h2>
<p>obtain stats from all pools, or from specified pool</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd pool stats poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool_name</strong>: CephPoolname</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-primary-affinity">
<h2>osd primary-affinity<a class="headerlink" href="#osd-primary-affinity" title="Permalink to this headline">¶</a></h2>
<p>adjust osd primary-affinity from 0.0 &lt;= &lt;weight&gt; &lt;= 1.0</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd primary-affinity osd.0 <span class="m">0</span>.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
<li><p><strong>weight</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0..1.0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-primary-temp">
<h2>osd primary-temp<a class="headerlink" href="#osd-primary-temp" title="Permalink to this headline">¶</a></h2>
<p>set primary_temp mapping pgid:&lt;id&gt;|-1 (developers only)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd primary-temp <span class="m">0</span> osd.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid</p></li>
<li><p><strong>id</strong>: CephOsdName</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-purge">
<h2>osd purge<a class="headerlink" href="#osd-purge" title="Permalink to this headline">¶</a></h2>
<p>purge all osd data from the monitors including the OSD id and CRUSH
position</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd purge osd.0 --force --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
<li><p><strong>force</strong>: CephBool</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-purge-new">
<h2>osd purge-new<a class="headerlink" href="#osd-purge-new" title="Permalink to this headline">¶</a></h2>
<p>purge all traces of an OSD that was partially created but never
started</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd purge-new osd.0 --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-repair">
<h2>osd repair<a class="headerlink" href="#osd-repair" title="Permalink to this headline">¶</a></h2>
<p>initiate repair on osd &lt;who&gt;, or use &lt;all|any&gt; to repair all</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd repair string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-require-osd-release">
<h2>osd require-osd-release<a class="headerlink" href="#osd-require-osd-release" title="Permalink to this headline">¶</a></h2>
<p>set the minimum allowed OSD release to participate in the cluster</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd require-osd-release octopus --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>release</strong>: CephChoices  strings=(octopus pacific quincy)</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-reweight">
<h2>osd reweight<a class="headerlink" href="#osd-reweight" title="Permalink to this headline">¶</a></h2>
<p>reweight osd to 0.0 &lt; &lt;weight&gt; &lt; 1.0</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd reweight osd.0 <span class="m">0</span>.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>id</strong>: CephOsdName</p></li>
<li><p><strong>weight</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0..1.0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-reweight-by-pg">
<h2>osd reweight-by-pg<a class="headerlink" href="#osd-reweight-by-pg" title="Permalink to this headline">¶</a></h2>
<p>reweight OSDs by PG distribution [overload-percentage-for-
consideration, default 120]</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd reweight-by-pg --oload<span class="o">=</span><span class="m">1</span> --max_change<span class="o">=</span><span class="m">0</span>.0 --max_osds<span class="o">=</span><span class="m">1</span>
  --pools<span class="o">=</span>poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>oload</strong>: CephInt</p></li>
<li><p><strong>max_change</strong>: CephFloat</p></li>
<li><p><strong>max_osds</strong>: CephInt</p></li>
<li><p><strong>pools</strong>: CephPoolname  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-reweight-by-utilization">
<h2>osd reweight-by-utilization<a class="headerlink" href="#osd-reweight-by-utilization" title="Permalink to this headline">¶</a></h2>
<p>reweight OSDs by utilization [overload-percentage-for-consideration,
default 120]</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd reweight-by-utilization --oload<span class="o">=</span><span class="m">1</span> --max_change<span class="o">=</span><span class="m">0</span>.0
  --max_osds<span class="o">=</span><span class="m">1</span> --no_increasing
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>oload</strong>: CephInt</p></li>
<li><p><strong>max_change</strong>: CephFloat</p></li>
<li><p><strong>max_osds</strong>: CephInt</p></li>
<li><p><strong>no_increasing</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-reweightn">
<h2>osd reweightn<a class="headerlink" href="#osd-reweightn" title="Permalink to this headline">¶</a></h2>
<p>reweight osds with {&lt;id&gt;: &lt;weight&gt;,…}</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd reweightn my_weights
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>weights</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-rm">
<h2>osd rm<a class="headerlink" href="#osd-rm" title="Permalink to this headline">¶</a></h2>
<p>remove osd(s) &lt;id&gt; [&lt;id&gt;…], or use &lt;any|all&gt; to remove all osds</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd rm --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-rm-nodown">
<h2>osd rm-nodown<a class="headerlink" href="#osd-rm-nodown" title="Permalink to this headline">¶</a></h2>
<p>allow osd(s) &lt;id&gt; [&lt;id&gt;…] to be marked down (if they are currently
marked as nodown), can use &lt;all|any&gt; to automatically filter out all
nodown osds</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd rm-nodown --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-rm-noin">
<h2>osd rm-noin<a class="headerlink" href="#osd-rm-noin" title="Permalink to this headline">¶</a></h2>
<p>allow osd(s) &lt;id&gt; [&lt;id&gt;…] to be marked in (if they are currently
marked as noin), can use &lt;all|any&gt; to automatically filter out all
noin osds</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd rm-noin --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-rm-noout">
<h2>osd rm-noout<a class="headerlink" href="#osd-rm-noout" title="Permalink to this headline">¶</a></h2>
<p>allow osd(s) &lt;id&gt; [&lt;id&gt;…] to be marked out (if they are currently
marked as noout), can use &lt;all|any&gt; to automatically filter out all
noout osds</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd rm-noout --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-rm-noup">
<h2>osd rm-noup<a class="headerlink" href="#osd-rm-noup" title="Permalink to this headline">¶</a></h2>
<p>allow osd(s) &lt;id&gt; [&lt;id&gt;…] to be marked up (if they are currently
marked as noup), can use &lt;all|any&gt; to automatically filter out all
noup osds</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd rm-noup --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-rm-pg-upmap">
<h2>osd rm-pg-upmap<a class="headerlink" href="#osd-rm-pg-upmap" title="Permalink to this headline">¶</a></h2>
<p>clear pg_upmap mapping for &lt;pgid&gt; (developers only)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd rm-pg-upmap <span class="m">0</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-rm-pg-upmap-items">
<h2>osd rm-pg-upmap-items<a class="headerlink" href="#osd-rm-pg-upmap-items" title="Permalink to this headline">¶</a></h2>
<p>clear pg_upmap_items mapping for &lt;pgid&gt; (developers only)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd rm-pg-upmap-items <span class="m">0</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-safe-to-destroy">
<h2>osd safe-to-destroy<a class="headerlink" href="#osd-safe-to-destroy" title="Permalink to this headline">¶</a></h2>
<p>check whether osd(s) can be safely destroyed without reducing data
durability</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd safe-to-destroy --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-scrub">
<h2>osd scrub<a class="headerlink" href="#osd-scrub" title="Permalink to this headline">¶</a></h2>
<p>initiate scrub on osd &lt;who&gt;, or use &lt;all|any&gt; to scrub all</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd scrub string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>who</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-set">
<h2>osd set<a class="headerlink" href="#osd-set" title="Permalink to this headline">¶</a></h2>
<p>set &lt;key&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd <span class="nb">set</span> full --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: CephChoices  strings=(full pause noup nodown noout noin nobackfill norebalance norecover noscrub nodeep-scrub notieragent nosnaptrim pglog_hardlimit)</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-set-backfillfull-ratio">
<h2>osd set-backfillfull-ratio<a class="headerlink" href="#osd-set-backfillfull-ratio" title="Permalink to this headline">¶</a></h2>
<p>set usage ratio at which OSDs are marked too full to backfill</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd set-backfillfull-ratio <span class="m">0</span>.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ratio</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0..1.0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-set-full-ratio">
<h2>osd set-full-ratio<a class="headerlink" href="#osd-set-full-ratio" title="Permalink to this headline">¶</a></h2>
<p>set usage ratio at which OSDs are marked full</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd set-full-ratio <span class="m">0</span>.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ratio</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0..1.0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-set-group">
<h2>osd set-group<a class="headerlink" href="#osd-set-group" title="Permalink to this headline">¶</a></h2>
<p>set &lt;flags&gt; for batch osds or crush nodes, &lt;flags&gt; must be a comma-
separated subset of {noup,nodown,noin,noout}</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd set-group --flags<span class="o">=</span>string --who<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>flags</strong>: (string)</p></li>
<li><p><strong>who</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-set-nearfull-ratio">
<h2>osd set-nearfull-ratio<a class="headerlink" href="#osd-set-nearfull-ratio" title="Permalink to this headline">¶</a></h2>
<p>set usage ratio at which OSDs are marked near-full</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd set-nearfull-ratio <span class="m">0</span>.0
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ratio</strong>: CephFloat  range= <code class="docutils literal notranslate"><span class="pre">0.0..1.0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-set-require-min-compat-client">
<h2>osd set-require-min-compat-client<a class="headerlink" href="#osd-set-require-min-compat-client" title="Permalink to this headline">¶</a></h2>
<p>set the minimum client version we will maintain compatibility with</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd set-require-min-compat-client my_version
  --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>version</strong>: (string)</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-setcrushmap">
<h2>osd setcrushmap<a class="headerlink" href="#osd-setcrushmap" title="Permalink to this headline">¶</a></h2>
<p>set crush map from input file</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd setcrushmap <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>prior_version</strong>: CephInt</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-setmaxosd">
<h2>osd setmaxosd<a class="headerlink" href="#osd-setmaxosd" title="Permalink to this headline">¶</a></h2>
<p>set new maximum osd value</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd setmaxosd <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>newmax</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-stat">
<h2>osd stat<a class="headerlink" href="#osd-stat" title="Permalink to this headline">¶</a></h2>
<p>print summary of OSD map</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd stat
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-stop">
<h2>osd stop<a class="headerlink" href="#osd-stop" title="Permalink to this headline">¶</a></h2>
<p>stop the corresponding osd daemons and mark them as down</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd stop --ids<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ids</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-test-reweight-by-pg">
<h2>osd test-reweight-by-pg<a class="headerlink" href="#osd-test-reweight-by-pg" title="Permalink to this headline">¶</a></h2>
<p>dry run of reweight OSDs by PG distribution [overload-percentage-for-
consideration, default 120]</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd test-reweight-by-pg --oload<span class="o">=</span><span class="m">1</span> --max_change<span class="o">=</span><span class="m">0</span>.0 --max_osds<span class="o">=</span><span class="m">1</span>
  --pools<span class="o">=</span>poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>oload</strong>: CephInt</p></li>
<li><p><strong>max_change</strong>: CephFloat</p></li>
<li><p><strong>max_osds</strong>: CephInt</p></li>
<li><p><strong>pools</strong>: CephPoolname  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-test-reweight-by-utilization">
<h2>osd test-reweight-by-utilization<a class="headerlink" href="#osd-test-reweight-by-utilization" title="Permalink to this headline">¶</a></h2>
<p>dry run of reweight OSDs by utilization [overload-percentage-for-
consideration, default 120]</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd test-reweight-by-utilization --oload<span class="o">=</span><span class="m">1</span> --max_change<span class="o">=</span><span class="m">0</span>.0
  --max_osds<span class="o">=</span><span class="m">1</span> --no_increasing
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>oload</strong>: CephInt</p></li>
<li><p><strong>max_change</strong>: CephFloat</p></li>
<li><p><strong>max_osds</strong>: CephInt</p></li>
<li><p><strong>no_increasing</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-tier-add">
<h2>osd tier add<a class="headerlink" href="#osd-tier-add" title="Permalink to this headline">¶</a></h2>
<p>add the tier &lt;tierpool&gt; (the second one) to base pool &lt;pool&gt; (the
first one)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd tier add poolname poolname --force_nonempty
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>tierpool</strong>: CephPoolname</p></li>
<li><p><strong>force_nonempty</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-tier-add-cache">
<h2>osd tier add-cache<a class="headerlink" href="#osd-tier-add-cache" title="Permalink to this headline">¶</a></h2>
<p>add a cache &lt;tierpool&gt; (the second one) of size &lt;size&gt; to existing
pool &lt;pool&gt; (the first one)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd tier add-cache poolname poolname <span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>tierpool</strong>: CephPoolname</p></li>
<li><p><strong>size</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-tier-cache-mode">
<h2>osd tier cache-mode<a class="headerlink" href="#osd-tier-cache-mode" title="Permalink to this headline">¶</a></h2>
<p>specify the caching mode for cache tier &lt;pool&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd tier cache-mode poolname writeback --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>mode</strong>: CephChoices  strings=(writeback readproxy readonly none)</p></li>
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-tier-remove">
<h2>osd tier remove<a class="headerlink" href="#osd-tier-remove" title="Permalink to this headline">¶</a></h2>
<p>remove the tier &lt;tierpool&gt; (the second one) from base pool &lt;pool&gt; (the
first one)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd tier remove poolname poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>tierpool</strong>: CephPoolname</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-tier-remove-overlay">
<h2>osd tier remove-overlay<a class="headerlink" href="#osd-tier-remove-overlay" title="Permalink to this headline">¶</a></h2>
<p>remove the overlay pool for base pool &lt;pool&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd tier remove-overlay poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
<dt class="field-odd">Command Flags</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-tier-rm">
<h2>osd tier rm<a class="headerlink" href="#osd-tier-rm" title="Permalink to this headline">¶</a></h2>
<p>remove the tier &lt;tierpool&gt; (the second one) from base pool &lt;pool&gt; (the
first one)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd tier rm poolname poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>tierpool</strong>: CephPoolname</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-tier-rm-overlay">
<h2>osd tier rm-overlay<a class="headerlink" href="#osd-tier-rm-overlay" title="Permalink to this headline">¶</a></h2>
<p>remove the overlay pool for base pool &lt;pool&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd tier rm-overlay poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-tier-set-overlay">
<h2>osd tier set-overlay<a class="headerlink" href="#osd-tier-set-overlay" title="Permalink to this headline">¶</a></h2>
<p>set the overlay pool for base pool &lt;pool&gt; to be &lt;overlaypool&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd tier set-overlay poolname poolname
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephPoolname</p></li>
<li><p><strong>overlaypool</strong>: CephPoolname</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-tree">
<h2>osd tree<a class="headerlink" href="#osd-tree" title="Permalink to this headline">¶</a></h2>
<p>print OSD tree</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd tree --epoch<span class="o">=</span><span class="m">0</span> --states<span class="o">=</span>up
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>epoch</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
<li><p><strong>states</strong>: CephChoices  strings=(up down in out destroyed)  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-tree-from">
<h2>osd tree-from<a class="headerlink" href="#osd-tree-from" title="Permalink to this headline">¶</a></h2>
<p>print OSD tree in bucket</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd tree-from --bucket<span class="o">=</span>string --epoch<span class="o">=</span><span class="m">0</span> --states<span class="o">=</span>up
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>bucket</strong>: (string)</p></li>
<li><p><strong>epoch</strong>: CephInt  range= <code class="docutils literal notranslate"><span class="pre">0</span></code></p></li>
<li><p><strong>states</strong>: CephChoices  strings=(up down in out destroyed)  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-unpause">
<h2>osd unpause<a class="headerlink" href="#osd-unpause" title="Permalink to this headline">¶</a></h2>
<p>unpause osd</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd unpause
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-unset">
<h2>osd unset<a class="headerlink" href="#osd-unset" title="Permalink to this headline">¶</a></h2>
<p>unset &lt;key&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd <span class="nb">unset</span> full
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>key</strong>: CephChoices  strings=(full pause noup nodown noout noin nobackfill norebalance norecover noscrub nodeep-scrub notieragent nosnaptrim)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-unset-group">
<h2>osd unset-group<a class="headerlink" href="#osd-unset-group" title="Permalink to this headline">¶</a></h2>
<p>unset &lt;flags&gt; for batch osds or crush nodes, &lt;flags&gt; must be a comma-
separated subset of {noup,nodown,noin,noout}</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd unset-group --flags<span class="o">=</span>string --who<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>flags</strong>: (string)</p></li>
<li><p><strong>who</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-utilization">
<h2>osd utilization<a class="headerlink" href="#osd-utilization" title="Permalink to this headline">¶</a></h2>
<p>get basic pg distribution stats</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd utilization
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="osd-versions">
<h2>osd versions<a class="headerlink" href="#osd-versions" title="Permalink to this headline">¶</a></h2>
<p>check running versions of OSDs</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph osd versions
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>osd</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="pg">
<h1>pg<a class="headerlink" href="#pg" title="Permalink to this headline">¶</a></h1>
<div class="section" id="pg-cancel-force-backfill">
<h2>pg cancel-force-backfill<a class="headerlink" href="#pg-cancel-force-backfill" title="Permalink to this headline">¶</a></h2>
<p>restore normal backfill priority of &lt;pgid&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg cancel-force-backfill --pgid<span class="o">=</span><span class="m">0</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-cancel-force-recovery">
<h2>pg cancel-force-recovery<a class="headerlink" href="#pg-cancel-force-recovery" title="Permalink to this headline">¶</a></h2>
<p>restore normal recovery priority of &lt;pgid&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg cancel-force-recovery --pgid<span class="o">=</span><span class="m">0</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-debug">
<h2>pg debug<a class="headerlink" href="#pg-debug" title="Permalink to this headline">¶</a></h2>
<p>show debug info about pgs</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg debug unfound_objects_exist
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>debugop</strong>: CephChoices  strings=(unfound_objects_exist degraded_pgs_exist)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-deep-scrub">
<h2>pg deep-scrub<a class="headerlink" href="#pg-deep-scrub" title="Permalink to this headline">¶</a></h2>
<p>start deep-scrub on &lt;pgid&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg deep-scrub <span class="m">0</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-dump">
<h2>pg dump<a class="headerlink" href="#pg-dump" title="Permalink to this headline">¶</a></h2>
<p>show human-readable versions of pg map (only ‘all’ valid with plain)</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg dump --dumpcontents<span class="o">=</span>all
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>dumpcontents</strong>: CephChoices  strings=(all summary sum delta pools osds pgs pgs_brief)  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-dump-json">
<h2>pg dump_json<a class="headerlink" href="#pg-dump-json" title="Permalink to this headline">¶</a></h2>
<p>show human-readable version of pg map in json only</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg dump_json --dumpcontents<span class="o">=</span>all
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>dumpcontents</strong>: CephChoices  strings=(all summary sum pools osds pgs)  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-dump-pools-json">
<h2>pg dump_pools_json<a class="headerlink" href="#pg-dump-pools-json" title="Permalink to this headline">¶</a></h2>
<p>show pg pools info in json only</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg dump_pools_json
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>pg</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-dump-stuck">
<h2>pg dump_stuck<a class="headerlink" href="#pg-dump-stuck" title="Permalink to this headline">¶</a></h2>
<p>show information about stuck pgs</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg dump_stuck --stuckops<span class="o">=</span>inactive --threshold<span class="o">=</span><span class="m">1</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>stuckops</strong>: CephChoices  strings=(inactive unclean stale undersized degraded)  (can be repeated)</p></li>
<li><p><strong>threshold</strong>: CephInt</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-force-backfill">
<h2>pg force-backfill<a class="headerlink" href="#pg-force-backfill" title="Permalink to this headline">¶</a></h2>
<p>force backfill of &lt;pgid&gt; first</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg force-backfill --pgid<span class="o">=</span><span class="m">0</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-force-recovery">
<h2>pg force-recovery<a class="headerlink" href="#pg-force-recovery" title="Permalink to this headline">¶</a></h2>
<p>force recovery of &lt;pgid&gt; first</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg force-recovery --pgid<span class="o">=</span><span class="m">0</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid  (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-getmap">
<h2>pg getmap<a class="headerlink" href="#pg-getmap" title="Permalink to this headline">¶</a></h2>
<p>get binary pg map to -o/stdout</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg getmap
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>pg</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-ls">
<h2>pg ls<a class="headerlink" href="#pg-ls" title="Permalink to this headline">¶</a></h2>
<p>list pg with specific pool, osd, state</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg ls --pool<span class="o">=</span><span class="m">1</span> --states<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pool</strong>: CephInt</p></li>
<li><p><strong>states</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-ls-by-osd">
<h2>pg ls-by-osd<a class="headerlink" href="#pg-ls-by-osd" title="Permalink to this headline">¶</a></h2>
<p>list pg on osd [osd]</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg ls-by-osd --osd<span class="o">=</span>osd.0 --pool<span class="o">=</span><span class="m">1</span> --states<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>osd</strong>: CephOsdName</p></li>
<li><p><strong>pool</strong>: CephInt</p></li>
<li><p><strong>states</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-ls-by-pool">
<h2>pg ls-by-pool<a class="headerlink" href="#pg-ls-by-pool" title="Permalink to this headline">¶</a></h2>
<p>list pg with pool = [poolname]</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg ls-by-pool --poolstr<span class="o">=</span>string --states<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>poolstr</strong>: (string)</p></li>
<li><p><strong>states</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-ls-by-primary">
<h2>pg ls-by-primary<a class="headerlink" href="#pg-ls-by-primary" title="Permalink to this headline">¶</a></h2>
<p>list pg with primary = [osd]</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg ls-by-primary --osd<span class="o">=</span>osd.0 --pool<span class="o">=</span><span class="m">1</span> --states<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>osd</strong>: CephOsdName</p></li>
<li><p><strong>pool</strong>: CephInt</p></li>
<li><p><strong>states</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-map">
<h2>pg map<a class="headerlink" href="#pg-map" title="Permalink to this headline">¶</a></h2>
<p>show mapping of pg to osds</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg map <span class="m">0</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-repair">
<h2>pg repair<a class="headerlink" href="#pg-repair" title="Permalink to this headline">¶</a></h2>
<p>start repair on &lt;pgid&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg repair <span class="m">0</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-repeer">
<h2>pg repeer<a class="headerlink" href="#pg-repeer" title="Permalink to this headline">¶</a></h2>
<p>force a PG to repeer</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg repeer <span class="m">0</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>osd</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-scrub">
<h2>pg scrub<a class="headerlink" href="#pg-scrub" title="Permalink to this headline">¶</a></h2>
<p>start scrub on &lt;pgid&gt;</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg scrub <span class="m">0</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>pgid</strong>: CephPgid</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>pg</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="pg-stat">
<h2>pg stat<a class="headerlink" href="#pg-stat" title="Permalink to this headline">¶</a></h2>
<p>show placement group status.</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph pg stat
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>pg</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="quorum">
<h1>quorum<a class="headerlink" href="#quorum" title="Permalink to this headline">¶</a></h1>
<div class="section" id="quorum-enter">
<h2>quorum enter<a class="headerlink" href="#quorum-enter" title="Permalink to this headline">¶</a></h2>
<p>force monitor back into quorum</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph quorum enter
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="quorum-exit">
<h2>quorum exit<a class="headerlink" href="#quorum-exit" title="Permalink to this headline">¶</a></h2>
<p>force monitor out of the quorum</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph quorum <span class="nb">exit</span>
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="quorum-status">
<h1>quorum_status<a class="headerlink" href="#quorum-status" title="Permalink to this headline">¶</a></h1>
<p>report status of monitor quorum</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph quorum_status
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="report">
<h1>report<a class="headerlink" href="#report" title="Permalink to this headline">¶</a></h1>
<p>report full status of cluster, optional title tag strings</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph report --tags<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>tags</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="service">
<h1>service<a class="headerlink" href="#service" title="Permalink to this headline">¶</a></h1>
<div class="section" id="service-dump">
<h2>service dump<a class="headerlink" href="#service-dump" title="Permalink to this headline">¶</a></h2>
<p>dump service map</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph service dump
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>service</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="service-status">
<h2>service status<a class="headerlink" href="#service-status" title="Permalink to this headline">¶</a></h2>
<p>dump service state</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph service status
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>service</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
</div>
<div class="section" id="sessions">
<h1>sessions<a class="headerlink" href="#sessions" title="Permalink to this headline">¶</a></h1>
<p>list existing sessions</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph sessions
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="smart">
<h1>smart<a class="headerlink" href="#smart" title="Permalink to this headline">¶</a></h1>
<p>Query health metrics for underlying device</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph smart my_devid
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>devid</strong>: (string)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="status">
<h1>status<a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h1>
<p>show cluster status</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph status
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="sync-force">
<h1>sync_force<a class="headerlink" href="#sync-force" title="Permalink to this headline">¶</a></h1>
<p>force sync of and clear monitor store</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph sync_force --yes_i_really_mean_it
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>yes_i_really_mean_it</strong>: CephBool</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="tell">
<h1>tell<a class="headerlink" href="#tell" title="Permalink to this headline">¶</a></h1>
<p>send a command to a specific daemon</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph tell --target<span class="o">=</span>name --args<span class="o">=</span>string
</pre></div>
</div>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>target</strong>: CephName</p></li>
<li><p><strong>args</strong>: (can be repeated)</p></li>
</ul>
</dd>
<dt class="field-odd">Ceph Module</dt>
<dd class="field-odd"><p>mon</p>
</dd>
<dt class="field-even">Required Permissions</dt>
<dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">rw</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="time-sync-status">
<h1>time-sync-status<a class="headerlink" href="#time-sync-status" title="Permalink to this headline">¶</a></h1>
<p>show time sync status</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph time-sync-status
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="version">
<h1>version<a class="headerlink" href="#version" title="Permalink to this headline">¶</a></h1>
<p>show mon daemon version</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph version
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>
<div class="section" id="versions">
<h1>versions<a class="headerlink" href="#versions" title="Permalink to this headline">¶</a></h1>
<p>check running versions of ceph daemons</p>
<dl class="field-list">
<dt class="field-odd">Example command</dt>
<dd class="field-odd"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ceph versions
</pre></div>
</div>
</dd>
<dt class="field-even">Ceph Module</dt>
<dd class="field-even"><p>mon</p>
</dd>
<dt class="field-odd">Required Permissions</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">r</span></code></p>
</dd>
</dl>
</div>



           </div>
           
          </div>
          <footer>
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
        <a href="../../architecture/" class="btn btn-neutral float-right" title="体系结构" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
        <a href="../" class="btn btn-neutral float-left" title="API 文档" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>
        &#169; Copyright 2016, Ceph authors and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0).

    </p>
  </div> 

</footer>
        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>